Skip to content

Commit 84665af

Browse files
authored
Populate README.md
1 parent ba17007 commit 84665af

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# break-bricks
1+
# Break Bricks
2+
3+
- Game/demo similar to the game [Breakout](https://en.wikipedia.org/wiki/Breakout_(video_game))
4+
- Written in C
5+
- On purpose, there is no "vector2" struct, in order to see how that would turn out
6+
- The included `makefile` does incremental compilation
7+
- Dependencies:
8+
- - C standard library
9+
- - SDL2
10+
- - SDL2_image
11+
12+
## How to run
13+
14+
1. Clone the repo
15+
2. `make init`
16+
3. `make run`
17+
18+
## Controls
19+
- Control the paddle with the mouse
20+
- `f`: Toggle fullscreen
21+
- `r`: Reset the game
22+
- `w`: Double the speed of the ball
23+
- `s`: Cut the speed of the ball in half
24+
- `F12`: Save a screenshot to the `screenshots` folder
25+
26+
## License
27+
GNU General Public License Version 3
28+
See file `LICENSE`
29+
30+
## Contributing
31+
Not currently accepting contributions.
32+
Feel free to open an issue.

0 commit comments

Comments
 (0)