aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1ac5fac..ed29e87 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,55 @@
# iot-onair-sign
+
+ESP32 firmware project for an on-air sign controlled from a smartphone over BLE.
+
+## Dependencies
+
+Required tools:
+- `esp-idf` (v5.x+)
+- `direnv`
+
+Note: ESP-IDF provides the required build toolchain (including CMake, Ninja, and compiler tools), so these do not need separate system installation.
+
+## Environment setup (recommended)
+
+This repo includes a `.envrc` file that loads ESP-IDF for this project only.
+
+1. Install and enable `direnv` in your shell.
+2. From the project root, allow the environment once:
+
+```bash
+direnv allow
+```
+
+After that, entering this directory will automatically load ESP-IDF variables.
+
+## Build
+
+1. Enter the project directory (direnv will auto-load the environment).
+2. Set the target (first time only):
+
+```bash
+idf.py set-target esp32
+```
+
+3. Build:
+
+```bash
+idf.py build
+```
+
+## Flash and monitor
+
+```bash
+idf.py -p /dev/ttyUSB0 flash monitor
+```
+
+(Adjust serial port as needed.)
+
+## Run unit tests (host)
+
+```bash
+cmake -S host_tests -B build_host_tests
+cmake --build build_host_tests
+ctest --test-dir build_host_tests --output-on-failure
+```