readme

1 files changed, 15 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..0043931
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,15 @@
+emulator
+========
+
+to run emulator you need <https://www.raylib.com/> installed.
+then `cd src && ./run_emulator.sh`.
+
+
+hardware
+========
+
+to compile firmware use <https://platformio.org/>.
+you need to create python venv or something, and then `pio run` will create firmware file.
+
+schematic is in diagram.json, use <https://wokwi.com/> to display.
+most of the stuff you can also see in platformio.ini, other than that connect button from pin 4 to ground.