Add some installation notes

[erdslangetjie.git] / README.txt

diff --git a/README.txt b/README.txt
index 748cea2bd3ec973f4e59235e1fc23ae859d96ca3..b4b72e3631604accbeac32bc745e50fcb3bd232d 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -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
 ----------------
@@ -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 
 -----------------