diff options
author | ThomasintAnker <thomasintanker1@gmail.com> | 2024-06-24 14:59:56 +0200 |
---|---|---|
committer | ThomasintAnker <thomasintanker1@gmail.com> | 2024-06-24 14:59:56 +0200 |
commit | a0c664908b9112306c5858ccb106d1a0e5555df7 (patch) | |
tree | 8ca77d1210d1683a97f4da131c6ffac8123d4375 /puzzle/readme.md | |
parent | 381149dd7a1f4d5f48dd5ac07186c73371ff3c04 (diff) | |
parent | ec7f5e970ed03acb33eb5dc3b67f3d52af52e6dc (diff) |
merge main into wip/mc
Diffstat (limited to 'puzzle/readme.md')
-rw-r--r-- | puzzle/readme.md | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/puzzle/readme.md b/puzzle/readme.md index 59c10b1..1b572ba 100644 --- a/puzzle/readme.md +++ b/puzzle/readme.md @@ -1,15 +1,15 @@ -# puzzles - -This folder contains the source code for all puzzle modules. +\defgroup puz puzzle +\brief Puzzle modules ## Arduino-based puzzle modules -Because of the poorly designed hardware (21-22) used during development -(23-24), some puzzle modules ended up being developed using Arduino boards. All -libraries in this repository use CMake for building (for consistency), which -also means the Arduino based puzzle modules use CMake. The CMakeLists.txt of -some puzzles uses the [Arduino-CMake-Toolchain][arduino-cmake]. To build any of -these subfolders, make sure you have done the following: +> [!NOTE] +> Because of the poorly designed hardware (21-22) used during development +> (23-24), all puzzle modules ended up being developed using Arduino boards. + +The Arduino based puzzle modules also use CMake with the +[Arduino-CMake-Toolchain][arduino-cmake]. To build any of these puzzles, make +sure you have done the following: - Install the official Arduino IDE - Open "Tools" > "Board" > "Board manager" @@ -17,6 +17,8 @@ these subfolders, make sure you have done the following: [arduino-cmake]: https://github.com/a9183756-gh/Arduino-CMake-Toolchain +<!-- + ## ESP-based puzzle modules ### ESP-IDF SDK Setup instructions @@ -29,3 +31,5 @@ these subfolders, make sure you have done the following: - [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) +--> + |