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  - USINGPYTHON.txt: A guide to writing an agent in Python.
  15  - SampleAgents.py : the sample agents.
  16  - agents/ : where you put your agent.
  17  - arenas/ : arenas define which agents play against which, and some other parameters.
  18  - link/ : Other languages belong here.
  19  - conf.py : has various useful things like the ability to turn on debug support.
  20
  21 The rest of the files are probably not useful to you, but just for completeness:
  22  - simulate.py : run a simulation.
  23  - uccProgComp.py : the guts of the competition.
  24  - rpsconst.py : various constants, such as the points table.
  25
  26 Ignore anything else. :P