diff --git a/examples/README.md b/examples/README.md index df635b4..251ac72 100755 --- a/examples/README.md +++ b/examples/README.md @@ -1 +1,31 @@ -# Examples +# Function Examples +## Read All + +`function/read_all.py` + +How to read all of the buttons on QwSTPad. + +## LED Wave + +`function/led_wave.py` + +Apply a wave effect across QwSTPad's onboard LEDs. + +## Pad Detect + +`function/pad_detect.py` + +How to detect multiple QwSTPads and handle their unexpected connection and disconnection. + +# Game Examples +## Random Maze + +`games/random_maze.py` + +A single player QwSTPad game demo. Navigate a set of mazes from the start (red) to the goal (green). Mazes get bigger / harder with each increase in level. Makes use of 1 QwSTPad. + +## Multi-Player + +`games/multi_player.py` + +A multi-player QwSTPad game demo. Each player drives a tank-like vehicle around an arena with the goal of hitting other players with projects to get the most points. Makes use of 1 to 4 QwSTPads. \ No newline at end of file