aboutsummaryrefslogtreecommitdiff
path: root/puzzle/readme.md
diff options
context:
space:
mode:
authorElwin Hammer <elwinhammer@gmail.com>2024-06-22 22:32:30 +0200
committerGitHub <noreply@github.com>2024-06-22 22:32:30 +0200
commita9eb2013e6b7297cfce4116179f4ab2d58d1c8d6 (patch)
tree0f16b75795d9926c5ea4a8ef52a695365837a8e4 /puzzle/readme.md
parentf121de7c7e3ca8f0dc526973a5ee2586485aad22 (diff)
parentd6440954806d381dae5b3df65b43192f897018c6 (diff)
Merge pull request #21 from lonkaars/master
Updating branch
Diffstat (limited to 'puzzle/readme.md')
-rw-r--r--puzzle/readme.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/puzzle/readme.md b/puzzle/readme.md
index 59c10b1..959c506 100644
--- a/puzzle/readme.md
+++ b/puzzle/readme.md
@@ -1,15 +1,20 @@
+\defgroup puz puzzle
+\brief Puzzle modules
+
# puzzles
This folder contains the source code for all 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.
+
+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:
- Install the official Arduino IDE
- Open "Tools" > "Board" > "Board manager"