summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore2
-rw-r--r--README.md40
-rw-r--r--main.spec38
3 files changed, 79 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 4ea05a1..45e2218 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
venv/
+build/
+dist/
__pycache__/ \ No newline at end of file
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
diff --git a/main.spec b/main.spec
new file mode 100644
index 0000000..2ba8dd9
--- /dev/null
+++ b/main.spec
@@ -0,0 +1,38 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+
+a = Analysis(
+ ['main.py'],
+ pathex=[],
+ binaries=[],
+ datas=[],
+ hiddenimports=[],
+ hookspath=[],
+ hooksconfig={},
+ runtime_hooks=[],
+ excludes=[],
+ noarchive=False,
+ optimize=0,
+)
+pyz = PYZ(a.pure)
+
+exe = EXE(
+ pyz,
+ a.scripts,
+ a.binaries,
+ a.datas,
+ [],
+ name='main',
+ debug=False,
+ bootloader_ignore_signals=False,
+ strip=False,
+ upx=True,
+ upx_exclude=[],
+ runtime_tmpdir=None,
+ console=True,
+ disable_windowed_traceback=False,
+ argv_emulation=False,
+ target_arch=None,
+ codesign_identity=None,
+ entitlements_file=None,
+)