Tweak android description
[erdslangetjie.git] / README.txt
index ff5f9cafe9676a6b4eb28b2bdd0434b615196944..b4b72e3631604accbeac32bc745e50fcb3bd232d 100644 (file)
@@ -1,11 +1,11 @@
-Peter's Thread Snake
-=====================
+Bane's Befuddlement
+===================
 
 Entry in PyWeek #16  <http://www.pyweek.org/16/>
 URL: http://www.pyweek.org/e/erdslangetjie
 Team: erdslangetjie
 Members: Neil Muller (drnlm)
-License: see LICENSE.txt
+License: ICS - see LICENSE.txt
 
 
 Requirements
@@ -13,6 +13,18 @@ Requirements
 
 This was developed using pygame 1.9.1 and kivy 1.6.0.
 
+Installation notes
+------------------
+
+For Linux, I created a virtualenv and used pip install kivy to setup the latest
+kivy environment. Pygame installation didn't work for me using pip, so I used
+the system packages for that.
+
+i.e.
+
+$ virtualenv --system-site-packages ve
+$ . ve/bin/activate
+$ pip install -r requirements.txt  # to install kivy and cython
 
 Running the Game
 ----------------
@@ -33,7 +45,7 @@ This time, you were prepared. Your trusty servant, Igor, has laid out a cunning
 maze leading to a secret underwater submarine that will allow you to flee
 without being caught.
 
-Of course, it would have been better if Igore had managed to get the map to you
+Of course, it would have been better if Igor had managed to get the map to you
 before things got compilcated, but the lack of a map is but a minor setback.
 
 
@@ -48,6 +60,14 @@ You always start each maze with a small lead, and can use gates to delay your
 pursuer. Your pursuer is relentless, though, so don't take too long deciding
 what to do. 
 
+Options
+------
+
+You can access the settings panel by pressing F1
+
+Note that changing the start level only takes effect on the next run, since we
+don't reload the config when that changes.
+
 
 Development notes 
 -----------------