Skip to content

Commit

Permalink
docs for examples
Browse files Browse the repository at this point in the history
  • Loading branch information
thirdr committed Nov 11, 2024
1 parent 9257dc6 commit 3a99ded
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3a99ded

Please sign in to comment.