CodeReviewPrep: README.txt

File README.txt, 2.1 KB (added by jelinson, 2 years ago)
Line 
1PROGRAM: TechTrek
2VERSION: v1.4.24.12
3COMPANY: Harvey Mudd College (HMC)
4AUTHORS: Erin Coughlan, Julius Elinson, Michael Morton & Rebecca Thomas
5CONTACT: jelinson@g.hmc.edu
6
7PROGRAM SUMMARY
8TechTrek is an educational computer game developed in Python with
9Pygame about the effects of various technologies in society, produced
10for Greg Orr through HMC course CS 121.
11
12HOW TO USE THIS DOCUMENT
13This document describes how to set-up and run the program TechTrek
14both from the packaged directory containing the executable file and
15the program trunk itself. If this document is accompanied by a file
16named TechTrek.exe in the same directory, read CONFIGURING THE
17EXECUTABLE. Otherwise read CONFIGURING THE TRUNK.
18
19CONFIGURING THE EXECUTABLE
20Dependencies:
21    - Windows XP or Windows 7 operating systems
22
23Instructions:
24The executable program does not require any additional packages or
25libraries. The only additional files needed are all contained in the
26_resources_ directory, which should accompany the executable.
27Important: do not rearrange or remove any subdirectories or files in
28this directory.
29
30CONFIGURING THE TRUNK
31Dependencies:
32    - Python 2.7.3: http://www.python.org/download/releases/2.7.3/
33    - Pygame 1.9.2: http://www.pygame.org/download.shtml
34
35Instructions:
36Once both Python and Pygame have been successfully installed, from
37this directory call
38
39    cd src/
40
41Then the program is launched by simply calling the Python interpretter
42via
43
44    python main.py
45
46If there are older versions of Python installed on the machine, you
47can ensure the correct version is used by alternatively use
48
49    python2.7 main.py
50
51This should launch the game and require no additional configuration.
52
53TROUBLESHOOTING
54Should the program crash for any reason, a description of the error
55will be written to a log file entitled TechTrek.log. If the error is
56an IOError, verify that the file or directory trying to be accessed
57indeed exists. Otherwise, invoke Python with the -v command for
58verbose ouput. Moreover, in the trunk, edit in src/globals.py DEBUG to
59be set to True. This will display additional internal information
60about the program as it is running.