Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PolyMarsDev authored Jan 19, 2021
1 parent f9453fa commit 3609bd0
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Flappuccino

Flappuccino is a game created in 48 hours for the [PyGame Community New Years Jam](https://itch.io/jam/pygame-community-jam) using Python with [Pygame](https://www.pygame.org).
## Screenshots
![](https://img.itch.zone/aW1hZ2UvODg3MDQ0LzUwMDQzOTkuZ2lm/original/vd0wHu.gif)

## Background
Information on how to play is available on the game's [itch.io page](https://polymars.itch.io/cursor-custodian).

## Usage
### Releases
A Windows build of the game is available [here](https://polymars.itch.io/flappuccino).
### Running from source
Grab the latest release of Python from [here](https://www.python.org/downloads/) and install Pygame by executing ``pip install pygame``.
Ensure ``main.py`` is in the same directory as ``\data`` and execute ``python main.py``.

## Contributing
Pull requests are welcome! For major refactors, please open an issue first to discuss what you would like to improve. Feel free to create a fork of this repository and use the code for any noncommercial purposes.

0 comments on commit 3609bd0

Please sign in to comment.