Add design notes
[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 Running the Game
12 ----------------
13
14 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
15
16 Othewise open a terminal / console and "cd" to the game directory and run:
17
18   python run_game.py
19
20
21 How to Play the Game
22 --------------------
23
24 TODO
25
26
27 Development notes 
28 -----------------
29
30 Creating a source distribution with::
31
32    python setup.py sdist
33
34 You may also generate Windows executables and OS X applications::
35
36    python setup.py py2exe
37    python setup.py py2app
38
39 Upload files to PyWeek with::
40
41    python pyweek_upload.py
42
43 Upload to the Python Package Index with::
44
45    python setup.py register
46    python setup.py sdist upload
47