From 00e6cfd3d003ffd2c01be8bba7592c31a4750d2b Mon Sep 17 00:00:00 2001 From: yuzu-eva Date: Sun, 22 Sep 2024 12:22:14 +0200 Subject: Added instructions to the readme --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1ced1a5..3a32519 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ # Asteroids Game -This is a game of Asteroids, created with the help of the guided project course on boot.dev \ No newline at end of file +This is a game of Asteroids, created with the help of the guided project course on boot.dev + +## Installation + +First, clone this repo: + +``` + git clone https://github.com/yuzu-eva/asteroids.git +``` + +You need Python3 and pygame installed. +To install pygame, create a virtual environment and use pip to install everything +in the requirements.txt: + +``` + python3 -m venv venv + source venv/bin/activate + pip install -r requirements.txt +``` + +Now you can launch the game with + +``` + python3 main.py +``` + +After you're done playing the game, you can leave the virtual environment with: + +``` + deactivate +``` + + +## Instructions + +Go forward and backward with the UP and DOWN arrow keys +Rotate your ship with LEFT and RIGHT arrow keys +Shoot the asteroids with SPACEBAR +Quit the game with Q -- cgit v1.2.3