diff --git a/README.md b/README.md index 0319349..b121159 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ + + + # creeper-adventure +Creeper adventure is a top down 2d adventure game that I am building with my son using pygame. + [![PyPI - Version](https://img.shields.io/pypi/v/creeper-adventure.svg)](https://pypi.org/project/creeper-adventure) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/creeper-adventure.svg)](https://pypi.org/project/creeper-adventure) @@ -16,6 +21,31 @@ pip install creeper-adventure ``` +## Running + +```console +# run the game +creeper-adventure + +# run in debug mode +creeper-adventure --debug + +# see all options available +creeper-adventure --help +``` + +## running with pipx + +`creeper-adventure` can also run using pipx if you have pipx installed. + +```console +pipx run creeper-adventure +``` + +## Download an exe + +pre-built binaries are available from the website [creeper-adventure](https://creeper-adventure.waylonwalker.com). + ## License `creeper-adventure` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.