aboutsummaryrefslogtreecommitdiff
path: root/puzzle/readme.md
blob: 1b572ba0f46ba041f7f957befbf9166ead0fa720 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
\defgroup puz puzzle
\brief 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.

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)

[arduino-cmake]: https://github.com/a9183756-gh/Arduino-CMake-Toolchain

<!--

## ESP-based puzzle modules

### ESP-IDF SDK Setup instructions

1. Install ESP-IDF extension in Visual Studio Code
2. Install using 'express' option
3. Install ESP-IDF v5.2.1 (release version)

   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)

-->