From 26f56e8ca66ff579ffd4687c5556cb4cd05d3934 Mon Sep 17 00:00:00 2001
From: HendrikRauh <114620133+HendrikRauh@users.noreply.github.com>
Date: Thu, 5 Mar 2026 23:37:49 +0100
Subject: [PATCH] add(documentation): development notes added

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.md b/README.md
index a4a913d..cfe1b81 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,44 @@ You have to short-circuit `R0` on the RS485 boards to enable the termination res
 
 ---
 
+## 🧑‍💻 Development
+
+### Required tools
+
+- `ESP-IDF` (includes `idf.py`)
+- `Python 3`
+- `invoke` (for project tasks)
+- Optional but recommended formatters:
+  - `clang-format`
+  - `black`
+  - `prettier`
+  - `svgo`
+  - `nixfmt`
+
+### Environment setup
+
+This repository includes a `flake.nix` with a ready-to-use development shell.
+
+```bash
+nix develop
+```
+
+Alternatively, you can use `direnv` to automatically enter the development shell when you `cd` into the project directory.
+
+Without Nix, install ESP-IDF and Python dependencies manually (especially `invoke`) and ensure `idf.py` is available in your shell.
+
+Run `invoke --list` to see all available tasks.
+
+Examples:
+
+```bash
+invoke flash
+invoke reset
+invoke config
+```
+
+---
+
 ## 📦 Case
 
 All print files (STL, STEP, X_T) can be found in [assets/case](/assets/case/). Alternatively you can view the project on [OnShape](https://cad.onshape.com/documents/7363818fd18bf0cbf094790e/w/52455282b39e47fbde5d0e53/e/9bec98aa83a813dc9a4d6ab2) where you can export the files in a format you like.