commit b063f479d16d3d5e67fbfad0d70fbea1e54bdf13
author gatecat <gatecat@ds0.me> Fri Nov 05 18:16:35 2021 +0000
committer gatecat <gatecat@ds0.me> Tue Dec 21 13:09:48 2021 +0000
tree 6546bad6b79e10a471aa6d2e68f288ed7760d695
parent 769fafe529654763697acd2bd83d54befbe2ed50

Add README

Signed-off-by: gatecat <gatecat@ds0.me>

README.md

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
 
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![UPRJ_CI](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [![Caravel Build](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml/badge.svg)](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.