Merge pull request #1 from smartsammler/master

Add requirements and README
pypewpew · Jan 16, 2019 · 5742b54 · 5742b54
2 parents b4bf54b + fa85773
commit 5742b54
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# pewmulator
+And emulator for running PewPew games on desktop computers
+
+To use it clone this repository, install the dependencies from the `requirements.txt` and work in the directory.
+```
+git clone https://github.com/pewpew-game/pewmulator.git
+cd pewmulator
+python -m pip install -r requirements.txt
+```
+
+Typically you want to start with a `code.py` that you can later copy to your hardware.
+
+The keys of the PewPew can be emulated by the arrow keys and `x` and `z`.
+
+The emulator does not support brightness.
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+pygame