The world is invalid (sometimes, when desirable)
[naja.git] / README.txt
1 Codename Naja
2 =============
3
4 Entry in PyWeek #18  <http://www.pyweek.org/18/>
5
6 URL:
7     http://pyweek.org/e/naja
8 Team:
9     Naja
10 Members:
11     Simon Cross
12     Neil Muller
13     Adrianna Pinska
14     Stefano Rivera
15     David Sharpe
16     Jeremy Thurgood
17 License:
18     see LICENSE.txt
19
20
21 Requirements
22 ============
23
24 The game requires pygame and pymunk. Requirements can be installed by
25
26   pip install -e .
27
28 Or
29
30   pip install -r requirements.txt
31
32 It was developed using python 2.7 and pygame 1.9.2. Older versions may or may
33 not work.
34
35
36 Running the Game
37 ----------------
38
39 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
40
41 Othewise open a terminal / console and "cd" to the game directory and run:
42
43   python run_game.py
44
45
46 How to Play the Game
47 --------------------
48
49 There are no ducks.
50
51
52 Development notes
53 -----------------
54
55 Creating a source distribution with::
56
57    ./scripts/build_unix.sh
58
59 You may also generate Windows executables and OS X applications::
60
61    python setup.py py2exe
62    python setup.py py2app
63
64 Later you might be able to upload files to PyWeek with::
65
66    python pyweek_upload.py
67
68 Later you might be able to upload to the Python Package Index with::
69
70    python setup.py register
71    python setup.py sdist upload