diff options
Diffstat (limited to 'puzzle/readme.md')
| -rw-r--r-- | puzzle/readme.md | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/puzzle/readme.md b/puzzle/readme.md index 21cddd3..1b572ba 100644 --- a/puzzle/readme.md +++ b/puzzle/readme.md @@ -1,29 +1,24 @@ \defgroup puz puzzle \brief Puzzle modules -# puzzles - -This folder contains the source code for all puzzle modules. - ## Arduino-based puzzle modules > [!NOTE] > Because of the poorly designed hardware (21-22) used during development > (23-24), all 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: +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" - Install the "Arduino AVR Boards" package (1.8.6 works at the time of writing) -- Install the Adafruit seesaw library and dependicies (for the neotrellis puzzle) -- Install the TM1637 library from Avishay Orpaz [arduino-cmake]: https://github.com/a9183756-gh/Arduino-CMake-Toolchain +<!-- + ## ESP-based puzzle modules ### ESP-IDF SDK Setup instructions @@ -36,3 +31,5 @@ of 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) +--> + |