aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-06-08 15:38:57 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-06-08 15:38:57 +0200
commite4b241c8ec4f12fe6ac479c2153cc540830e6a5d (patch)
treef2cbc6ed8421449f605e7e602785f45779cde6cc /readme.md
parentebf45f066dfe308b6de1472399672fd132c157b4 (diff)
clean up repository
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md49
1 files changed, 19 insertions, 30 deletions
diff --git a/readme.md b/readme.md
index ac703b7..457ffaa 100644
--- a/readme.md
+++ b/readme.md
@@ -17,16 +17,18 @@ 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
-|`/i2ctcp`|I<sup>2</sup>C over TCP protocol functions (used by main and client)
-|`/lib`|Libraries (tracked as [submodules](#submodules))
-|`/main`|Main controller (RPi pico) software
-|`/puzzle/<name>`|Puzzle sources, each puzzle has its own subdirectory
-|`/shared`|Shared code
-|`/test`|Unit test framework (currently unutilized)
+```
+/client desktop PC application for controlling the puzzle box
+/docs project documentation in AsciiDoc(tor) format
+/lib custom libraries and submodules
+├───/i2ctcp I2C over TCP protocol functions (used by main and client)
+├───/mpack MsgPack CMake configuration and extension
+└───/pbdrv puzzle bus driver (module driver + (de)serializing functions)
+/main main controller (RPi pico) software
+/puzzle/<name> puzzle sources, each puzzle has its own subdirectory
+/shared (unused) shared code
+/test unit tests
+```
### Code style
@@ -49,25 +51,12 @@ git submodule update --init --recursive --depth 1
until your problems go away.
-<!--
-## Tests
-
-```
-mkdir -p test/build
-cd test/build
-cmake ..
-make
-make test
-```
--->
-
-## ESP SDK setup
-
-1. Install ESP-IDF extension in Visual Studio Code
-2. Install using 'express' option
-3. Install ESP-IDF v5.2.1 (release version)
+## lazy\.mk
- Additional help:
- - [For windows](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/windows-setup.html#get-started-windows-first-steps)
- - [For Linux](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html#get-started-linux-macos-first-steps)
+[`lazy.mk`](./lazy.mk) is a file made by Loek, and includes some rules for
+forwarding `make` calls to `cmake` and `ninja`. **This is purely for
+convenience, and should not become an essential part of the build system**.
+This file should be included at the end of a regular makefile. Any targets
+defined in a makefile can be used as-is, while targets that would otherwise be
+unknown will be forwarded to Ninja.