source: README.txt @ 287:67387621c61b

Last change on this file since 287:67387621c61b was 287:67387621c61b, checked in by David Fraser <davidf@…>, 7 years ago

Added requirements.txt and use it from setup.py

File size: 1.3 KB
Line 
1Your Game Title
2===============
3
4Entry in PyWeek #17  <http://www.pyweek.org/17/>
5URL: http://pyweek.org/e/nagslang
6Team: Cape Viper (leave the "Team: bit")
7Members: YOUR TEAM MEMBERS (leave the "Members: bit")
8License: see LICENSE.txt
9
10Requirements
11============
12
13The game requires pygame and pymunk. Requirements can be installed by
14  pip install -e .
15Or
16  pip install -r requirements.txt
17
18It was developed using python 2.7, pymunk 4.0 and pygame 1.9.2. Older
19versions may or may not work.
20
21The editor also requires Albow 2.2.0
22  (from http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/)
23
24
25Running the Game
26----------------
27
28On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
29
30Othewise open a terminal / console and "cd" to the game directory and run:
31
32  python run_game.py
33
34
35How to Play the Game
36--------------------
37
38
39
40Move the cursor around the screen with the mouse.
41
42Press the left mouse button to fire the ducks.
43
44
45Development notes
46-----------------
47
48Creating a source distribution with::
49
50   python setup.py sdist
51
52You may also generate Windows executables and OS X applications::
53
54   python setup.py py2exe
55   python setup.py py2app
56
57Upload files to PyWeek with::
58
59   python pyweek_upload.py
60
61Upload to the Python Package Index with::
62
63   python setup.py register
64   python setup.py sdist upload
65
Note: See TracBrowser for help on using the repository browser.