From c61c1f93c0820b0cb5c31090028f7eea6f2b6e95 Mon Sep 17 00:00:00 2001
From: ThomasAvans <tv.intanker@student.avans.nl>
Date: Tue, 16 Apr 2024 14:27:02 +0200
Subject: Added build instructions for ESP

---
 readme.md | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 08eac3c..cf2f4c7 100644
--- a/readme.md
+++ b/readme.md
@@ -11,3 +11,9 @@ cmake ..
 make
 make test
 ```
+
+## ESP
+1. Download ESP-IDF extension in vscode
+2. Install using 'express' option
+3. For windows: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/windows-setup.html#get-started-windows-first-steps
+4. For Linux: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html#get-started-linux-macos-first-steps
-- 
cgit v1.2.3


From 4354adcf0ae2eabbf419a76fc97746cb71962826 Mon Sep 17 00:00:00 2001
From: ThomasAvans <tv.intanker@student.avans.nl>
Date: Wed, 17 Apr 2024 19:06:24 +0200
Subject: Improved ESP build instructions

---
 readme.md | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index cf2f4c7..01fd063 100644
--- a/readme.md
+++ b/readme.md
@@ -13,7 +13,8 @@ make test
 ```
 
 ## ESP
-1. Download ESP-IDF extension in vscode
+1. Install ESP-IDF extension in vscode
 2. Install using 'express' option
-3. For windows: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/windows-setup.html#get-started-windows-first-steps
-4. For Linux: https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html#get-started-linux-macos-first-steps
+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
-- 
cgit v1.2.3


From 488899377dc72989a178173662f95d25fc69c59f Mon Sep 17 00:00:00 2001
From: lonkaars <loek@pipeframe.xyz>
Date: Fri, 26 Apr 2024 16:45:10 +0200
Subject: add submodule init instructions to readme

---
 readme.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 01fd063..1ad72e9 100644
--- a/readme.md
+++ b/readme.md
@@ -2,6 +2,18 @@
 
 Avans University of Applied Sciences project puzzle box.
 
+## submodules
+
+This repository tracks (most) dependencies via git submodules.
+
+If something is complaining about missing files
+
+```
+git submodule update --init --recursive --depth 1
+```
+
+until your problems go away.
+
 ## Tests
 
 ```
-- 
cgit v1.2.3


From 821974afa85d9daa2c0aaa49c109c5c4b4891ae4 Mon Sep 17 00:00:00 2001
From: lonkaars <loek@pipeframe.xyz>
Date: Sun, 19 May 2024 17:24:37 +0200
Subject: add housekeeping notices

---
 .editorconfig | 12 ++++++++++++
 readme.md     | 26 ++++++++++++++++++++++++++
 2 files changed, 38 insertions(+)
 create mode 100644 .editorconfig

(limited to 'readme.md')

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..cd37156
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+insert_final_newline = true
+
+[*.md]
+indent_style = space
+indent_size = 2
+
+
diff --git a/readme.md b/readme.md
index 1ad72e9..7802f5c 100644
--- a/readme.md
+++ b/readme.md
@@ -2,6 +2,32 @@
 
 Avans University of Applied Sciences project puzzle box.
 
+## tidyness
+
+Please keep this repository tidy by being aware of the following conventions!
+
+### folder structure
+
+|folder|contains|
+|-|-|
+|`/client`|Desktop PC application for controlling the puzzle box
+|`/docs`|Project documentation in AsciiDoc(tor) format
+|`/lib`|Libraries (tracked as [submodules](#submodules))
+|`/main`|Main controller (RPi pico) software
+|`/proto`|Puzzle bus TCP protocol functions (used by main and client)
+|`/puzzle/<name>`|Puzzle sources, each puzzle has its own subdirectory
+|`/shared`|Auxiliary shared code
+|`/test`|Unit test framework (currently unutilized)
+
+### code style
+
+An `.editorconfig` file is provided in this repository. Please install the
+[EditorConfig](https://editorconfig.org/) plugin for your text editor of choice
+to automatically use these.
+
+Currently, no linter/formatter is configured for maintaining consistent code
+style.
+
 ## submodules
 
 This repository tracks (most) dependencies via git submodules.
-- 
cgit v1.2.3