fw: Add README.md

1 files changed, 33 insertions, 0 deletions

diff --git a/fw/README.md b/fw/README.md
new file mode 100644
index 0000000..f58008f
--- /dev/null
+++ b/fw/README.md
@@ -0,0 +1,33 @@
+# soundbox firmware
+
+This is the firmware for soundbox. It is based on the Zephyr real time
+operating system [1].
+
+## Setup Python environment
+
+```
+python -m venv zephyrproject/.venv
+source zephyrproject/.venv/bin/activate
+pip install -r zephyrproject/requirements.txt
+```
+
+## Build
+
+```
+cmake -Bbuild -GNinja
+ninja -C build
+```
+
+## Flash
+
+```
+esptool.py --chip auto write_flash 0x1000 build/zephyr/zephyr.bin
+```
+
+## Get shell output
+
+```
+picocom -b 115200 /dev/ttyUSB0
+```
+
+[1]: https://zephyrproject.org