Adds README, moves fpga stuff to a subdirectory.

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9bb3c4d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# numini
+
+A small CPU and a computer built around it.
+
+## Overview
+
+Currently, the planned hardware is based around an [iCEBreaker] and an [Inkplate 6].
+The [original Inkplate 6 case]'s top is used (since the Inkplate came glued to it), but the bottom is replaced by a 3D-printed custom case that leaves room for the remainder of the components and ports on the bottom.
+The Inkplate provides power via a lithium battery, and access to its display, its microSD card, and its Wi-Fi and Bluetooth connectivity.
+The iCEBreaker is connected to the Inkplate over both I²C and UART.
+The iCEBreaker is augmented with a [quad HyperRAM PMOD] module, which it uses for main memory.
+
+[iCEBreaker]: https://docs.icebreaker-fpga.org/
+[Inkplate 6]: https://soldered.com/product/soldered-inkplate-6-6-e-paper-board/
+[original Inkplate 6 case]: https://github.com/SolderedElectronics/Inkplate-6-hardware/blob/master/3D%20printable%20case/Original%20case
+[quad HyperRAM PMOD]: https://1bitsquared.com/products/pmod-hyperram
+
+The different components are in the following subdirectories:
+
+- `case/` contains the [OpenSCAD] code for the case design.
+- `fpga/` contains the [Bluespec] code that runs on the iCEBreaker.
+- `inkplate/` contains the code that runs on the Inkplate.
+- `simhost/` contains Rust code that implements simulated peripherals for bluesim.
+
+[Bluespec]: https://github.com/B-Lang-org/bsc
+[OpenSCAD]: https://openscad.org/