Add missed requirements. Update readme
[erdslangetjie.git] / README.txt
1 Peter's Thread Snake
2 =====================
3
4 Entry in PyWeek #16  <http://www.pyweek.org/16/>
5 URL: http://www.pyweek.org/e/erdslangetjie
6 Team: erdslangetjie
7 Members: Neil Muller (drnlm)
8 License: see LICENSE.txt
9
10
11 Requirements
12 ------------
13
14 This was developed using pygame 1.9.1 and kivy 1.6.0.
15
16
17 Running the Game
18 ----------------
19
20 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
21
22 Othewise open a terminal / console and "cd" to the game directory and run:
23
24   python run_game.py
25
26
27 How to Play the Game
28 --------------------
29
30 TODO
31
32
33 Development notes 
34 -----------------
35
36 Creating a source distribution with::
37
38    python setup.py sdist
39
40 You may also generate Windows executables and OS X applications::
41
42    python setup.py py2exe
43    python setup.py py2app
44
45 Upload files to PyWeek with::
46
47    python pyweek_upload.py
48
49 Upload to the Python Package Index with::
50
51    python setup.py register
52    python setup.py sdist upload
53