Skip to content

Commit

Permalink
better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Yash Goyal committed May 16, 2023
1 parent 9135749 commit 8def818
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,11 @@ Occasionally the player will receive a power-up to [teleport](https://www.youtub


## Download
You can do any one of the following to run the game. Downloading from releases is recommended
You can do any one of the following to run the game. Downloading from releases is recommended.

### Release
Head to [releases](https://github.com/ycatsh/from-another-planet/releases) and download the latest version. After downloading and extracting the zip file run `game.exe`
Head to [releases](https://github.com/ycatsh/from-another-planet/releases) and download the latest version. After downloading and extracting the zip file run `game.exe`

### Source Code
Download the repository and the required dependencies from `requirements.txt` then run the python file. Otherwise, you can also create your own build using the source code:
Otherwise, To run or build with the source code: download the repository and the required dependencies from `requirements.txt` then run the python file. You can also create your own build using the source code:
1. Install [`pyinstaller`](https://pypi.org/project/pyinstaller/) from pip
2. In the project directory run `pyinstaller game.py --onefile --noconsole`
3. delete `build/` and create a new folder for the game
Expand Down

0 comments on commit 8def818

Please sign in to comment.