diff --git a/README.md b/README.md index 7a65a21..3af82f5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ -# VimJam2 +# Pinmik Panik ! -My entry for the [VimJam2](https://itch.io/jam/vimjam2) \ No newline at end of file +My entry for the [VimJam2](https://itch.io/jam/vimjam2). +The requirement was the word "boss", and the theme was "on the edge". +An arcade game with little creatures, try to have the best highscore :D + +I'll not maintain this repository past the jam's deadline, but feel free to fork it for your own projects. + +Also, take a look at the [credits file](credits.md) + +## How I compiled it + +### Depedencies + +I'm using [pygame](https://www.pygame.org/news), install it with +``` +pip install pygame +``` + +### With Linux/Unix + +```bash +pyinstaller --onefile --noconsole launcher.py --add-data "gamedata:gamedata" --icon icon.png +``` + +### With Windows + +```bash +pyinstaller --onefile --noconsole launcher.py --add-data "gamedata;gamedata" --icon icon.png +``` diff --git a/icon.png b/icon.png new file mode 100644 index 0000000..6f33bb9 Binary files /dev/null and b/icon.png differ