Skip to content

Commit

Permalink
Populate README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Costava authored Aug 18, 2020
1 parent ba17007 commit 84665af
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
# break-bricks
# 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.

0 comments on commit 84665af

Please sign in to comment.