asteroids/README.md

40 lines
931 B
Markdown

# Asteroids
`Asteroids` is a very simple asteroids game developed with Python and [Pygame](https://www.pygame.org/docs/).
## Repository mirrors
- **Code Flow:** https://codeflow.dananglin.me.uk/apollo/asteroids
- **GitHub:** https://github.com/dananglin/asteroids
## Requirements
To run the application you'll need a recent version of Python 3.
This application was built and tested with Python 3.12.3.
You'll also need to install pygame.
The installation instructions are below.
## How to run the game
- Clone this repository to your local machine.
```
git clone https://github.com/dananglin/asteroids.git
cd asteroids
```
- (Optional) create a virtual environment and activate it.
```
python3 -m venv venv
source venv/bin/activate
```
- Install the dependencies listed in `requirements.txt`.
```
pip3 install -r requirements.txt
```
- Launch the game.
```
python3 main.py
```