From a89d3a1f8c9e1399c5e1cc5ac50176bd4c0ca581 Mon Sep 17 00:00:00 2001
From: jonny_ji7 <jonny@wwad.de>
Date: Tue, 21 Feb 2023 21:55:51 +0100
Subject: [PATCH] Update Readme: Add install instructions

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4a565fa..ed15580 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,58 @@
-# Hardware
+# Links
 ## connection plan
 See [connection-plan.pdf](connection-plan.pdf)  
 
+## flowchart firmware
+See [function-diagram.drawio.pdf](function-diagram.drawio.pdf)  
+
+
+
+# Installation
+### Install esp-idf
+Currently using ESP-IDF v4.1.4 (5.X did not work due to breaking changes and CMAKE issues)
+1. download esp-idf: 
+```
+clone the esp-idf repository from github
+```
+2. checkout version needed:
+```
+git checkout release/4.1
+```
+3. run install script e.g.
+```
+/opt/esp-idf/install.sh
+```
+
+### Clone this repo
+```
+git clone git@github.com:Jonny999999/cable-length-cutter.git
+```
+
+
+
+# Compilation
+### Set up environment
+```bash
+source /opt/esp-idf/export.sh
+```
+(run once in terminal)
+
+### Compile
+```bash
+idf.py build
+#or
+idf.py build flash monitor
+```
+
+
+
+
+# Usage
+[WIP...]
+
+
+
+
 
 # Components
 ## rotary encoder LPD3806-600BM-G5-24C