Update readme

main
Sean Hickey 2022-06-18 11:18:53 -07:00
parent b3c161eed2
commit 4ef88ad21f
1 changed files with 17 additions and 0 deletions

View File

@ -1,5 +1,21 @@
# Carpy Breakout
This project depends on [SDL2][2]. This library should be available
for nearly any system you can find.
* Debian - libsdl2-dev
* pkgsrc - devel/SDL2
Then simply run `make` to build.
Launch the game with `./carpy-breakout`.
Press `F` to toggle fullscreen.
Press `L` to toggle wireframe mode.
Press `K` to toggle freelook mode.
## Why "Carpy"?
Because it's a funny misspelling of "Crappy". This was originally
@ -18,3 +34,4 @@ projects used to build this one.
[1]: https://opensource.org/licenses/BSD-2-Clause
[2]: https://www.libsdl.org/