Skip to content

Commit 6745505

Browse files
committed
Update README.md
1 parent f1bde2a commit 6745505

File tree

1 file changed

+39
-8
lines changed

1 file changed

+39
-8
lines changed

README.md

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,45 @@ A [Simon Game](https://en.wikipedia.org/wiki/Simon_(game)) implementation
44
for the [Raspberry Pi Pico](https://www.raspberrypi.org/products/raspberry-pi-pico/).
55

66
## Features
7+
78
- Includes 3 games:
8-
- The classic simon game.
9-
- *Catch me!*, where lights start blinking and the player need to follow
9+
- The classic simon game.
10+
- *Catch me!*, where lights start blinking and the player need to follow
1011
them without falling behind (with a margin).
11-
- TBD.
12+
- *Quick draw*, multiplayer, when the lights turn on, the first one to hit
13+
the button wins.
1214
- Settings for the games where you can choose:
13-
- from 3 leves of difficulty,
14-
- playing only with lights, only with sound or with both.
15+
- from 3 leves of difficulty,
16+
- playing only with lights, only with sound or with both.
17+
18+
## How does the menu works
19+
20+
- Red button: Simon
21+
- Blue button: *Catch me!*
22+
- Yellow button: *Quick draw*
23+
- Green button: Settings
24+
- Red: Difficulty
25+
- Red: easy
26+
- Blue: medium
27+
- Yellow: hard
28+
- Green: back
29+
- Blue: Sound/Leds
30+
- Red: both
31+
- Blue: only Leds
32+
- Yellow: only sound
33+
- Green: back
34+
- Yellow/Green: back
1535

1636
## To compile
17-
There is a `CMakeLists.txt` file inside the `src` directory. You should also have [set up the pico C SDK](https://datasheets.raspberrypi.org/pico/getting-started-with-pico.pdf).
37+
38+
There is a `CMakeLists.txt` file to build the project. You should also have [set up the pico C SDK](https://datasheets.raspberrypi.org/pico/getting-started-with-pico.pdf) and CMake installed.
39+
40+
```sh
41+
mkdir build
42+
cd build
43+
cmake ..
44+
make
45+
```
1846

1947
## Circuit
2048

@@ -27,7 +55,10 @@ caught some noise when using PWM to control the LEDs.
2755

2856
The buttons are pulled down by the pico.
2957

58+
This project is licensed under the terms of the MIT license.
3059

60+
## Links
3161

32-
33-
This project is licensed under the terms of the MIT license.
62+
- `pioasm` code for the button debounce. This project had a great idea on how to do this. [https://github.com/GitJer/Button-debouncer](https://github.com/GitJer/Button-debouncer)
63+
- The Pico SDK [https://github.com/raspberrypi/pico-sdk](https://github.com/raspberrypi/pico-sdk)
64+
- Micropython implementation for the pico. I used this to understand how the SDK works in a real environment. [https://github.com/raspberrypi/micropython](https://github.com/raspberrypi/micropython)

0 commit comments

Comments
 (0)