diff --git a/README.md b/README.md index 02ca7c0..55a3dd4 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -# break-bricks \ No newline at end of file +# Break Bricks + +- Game/demo similar to the game [Breakout](https://en.wikipedia.org/wiki/Breakout_(video_game)) +- Written in C +- On purpose, there is no "vector2" struct, in order to see how that would turn out +- The included `makefile` does incremental compilation +- Dependencies: +- - C standard library +- - SDL2 +- - SDL2_image + +## How to run + +1. Clone the repo +2. `make init` +3. `make run` + +## Controls +- Control the paddle with the mouse +- `f`: Toggle fullscreen +- `r`: Reset the game +- `w`: Double the speed of the ball +- `s`: Cut the speed of the ball in half +- `F12`: Save a screenshot to the `screenshots` folder + +## License +GNU General Public License Version 3 +See file `LICENSE` + +## Contributing +Not currently accepting contributions. +Feel free to open an issue.