Add README Signed-off-by: gatecat <gatecat@ds0.me>
diff --git a/README.md b/README.md index 3706438..e8d31ee 100644 --- a/README.md +++ b/README.md
@@ -1,11 +1,17 @@ -# Caravel User Project +# nMigen+Coriolis Test SoC -[](https://opensource.org/licenses/Apache-2.0) [](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml) +This is a submission of a test SoC for MPW4 built from https://github.com/ChipFlow/mpw4 -| :exclamation: Important Note | -|-----------------------------------------| - -## Please fill in your project documentation in this README.md file +It contains: + - Minerva RV32IM CPU + - 512 bytes SRAM + - (Q)SPI flash for code and data memory using `spimemio` from picosoc + - HyperRAM for RAM extension using a derivative of `litehyperbus` + - 8-bit GPIO + - UART, timer, and interrupt controller -Refer to [README](docs/source/index.rst) for this sample project documentation. +Built using: + - nMigen + - Yosys+ABC + - [Coriolis](https://gitlab.lip6.fr/vlsi-eda/coriolis) for PnR; with [PDKMaster](https://gitlab.com/Chips4Makers/PDKMaster) and [flexcell](https://gitlab.com/Chips4Makers/c4m-flexcell) used in place of the standard sky130 cells.