update readme for 4ft4
diff --git a/README.md b/README.md index 3077244..191f024 100644 --- a/README.md +++ b/README.md
@@ -1,12 +1,16 @@ -# Caravel User Project +# Caravel 4ft4 -[](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) +4ft4 is a clone of the MCS-4 architecture (4004 CPU, 4001 ROM, 4002 RAM), +with a wishbone backdoor interface to the "ROM" and the RAM that enables +loading a program for execution and inspecting/modifying the RAM. -| :exclamation: Important Note | -|-----------------------------------------| +This is an integration of 4ft4 into the caravel harness, with the 4ft4 wishbone +backdoor interface connected to the caravel management processor. -## Please fill in your project documentation in this README.md file +### License information -Refer to [README](docs/source/quickstart.rst) for a quick start of how to use caravel_user_project +caravel_user_project and modifications: Apache 2.0. The original +caravel_user_project that this is based on is +https://github.com/efabless/caravel_user_project. -Refer to [README](docs/source/index.rst) for this sample project documentation. +4ft4: BSD.