more documentation and some cleanup
[progcomp10.git] / src / README.txt
1 Hi there,
2
3 You've reached the source directory of the UCC::ProgComp 2010.
4
5 For documentation, see the contents of the "doc" directory.
6
7 The first thing you'll probably want to do is see it work. Try running:
8
9 ./simulate -v
10
11 to see the sample agents duke it out.
12
13 This is a brief overview of the included files and directories:
14  - SampleAgents.py : the sample agents. This is the bit you care about!
15  - arenas/ : arenas define which agents play against which, and some other parameters.
16  - link/ : Other languages belong here.
17  - conf.py : has various useful things like the ability to turn on debug support.
18
19 The rest of the files are probably not useful to you, but just for completeness:
20  - simulate.py : run a simulation.
21  - uccProgComp.py : the guts of the competition.
22  - rpsconst.py : various constants, such as the points table.
23
24 Ignore anything else. :P

UCC git Repository :: git.ucc.asn.au