From fc1959bd9887ecc4d4ceb62a53e87abc6f49ef00 Mon Sep 17 00:00:00 2001 From: Nathan Ringo Date: Mon, 23 Sep 2024 21:46:34 -0500 Subject: Adds README, moves fpga stuff to a subdirectory. --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md (limited to 'README.md') 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/ -- cgit v1.2.3