X-Git-Url: https://git.ctpug.org.za/?a=blobdiff_plain;f=README;h=0553d38a17bf6c4642ab132c05fa2e7059a3517b;hb=ec18a4dde4d14bd4486fb936476266e8511b169b;hp=a276e70856676f996570055638713ef3df4f4669;hpb=3f89512f0935ee86dd18d8209bd30dd3ebfcb273;p=koperkapel.git

diff --git a/README b/README
index a276e70..0553d38 100644
--- a/README
+++ b/README
@@ -1,4 +1,25 @@
 This is the repo for the koperkapel team entry for pyweek 21.
 
-Created a few hours before the competition start to sort out irker config and
-such.
+Quickstart
+==========
+
+The koperkapel entry uses pygame-zero. Pygame-zero requires Python 3.
+Instructions for installing pygame-zero on various operating systems
+can be found at https://pygame-zero.readthedocs.org/en/latest/installation.html.
+
+Running the game
+================
+
+This game requires Python 3.
+
+Run the game using:
+
+$ python -m koperkapel
+
+or, if your default python is Python 2,
+
+$ python3 -m koperkapel
+
+or just
+
+$ ./run_game.py