1 files changed, 20 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index e69de29..01fd063 100644
--- a/readme.md
+++ b/readme.md
@@ -0,0 +1,20 @@
+# puzzle box
+
+Avans University of Applied Sciences project puzzle box.
+
+## Tests
+
+```
+mkdir -p test/build
+cd test/build
+cmake ..
+make
+make test
+```
+
+## ESP
+1. Install ESP-IDF extension in vscode
+2. Install using 'express' option
+3. Install ESP-IDF v5.2.1 (release version)
+4. For windows: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/windows-setup.html#get-started-windows-first-steps
+5. For Linux: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html#get-started-linux-macos-first-steps