src/README

   1 <<PLEASE SEE THE CONTENTS OF doc/ FIRST>>
   2
   3 Hi there,
   4
   5 Thanks for taking interest in the UCC Programming Competition 2010. If you
   6 don't already know what it's all about, check out the information provided in
   7 the docs directory, which contains a full and authoritative* description for
   8 the running of the competition.
   9
  10 This file is by no means complete, and not ready for circulation.
  11
  12 The first thing you'll probably want to do is see it work. Try running:
  13
  14 ./simulate -v
  15
  16 to see the sample agents duke it out for up to 150 rounds (the current sample
  17 agents suck - rounds either go for seconds or for ages). After that, take a
  18 look at sampleAgents.py to see how agents are implemented on top of the
  19 BaseAgent and LearningAgent classes. When you're ready to try out your own,
  20 edit the first few lines of simulate.py to include your agent.
  21
  22 ...and if all you're interested in is participating, that's it! You can stop
  23 reading, and start work on the agent that will outsmart them all!
  24
  25
  26 * Or rather, it wil by the time this package is ready for distribution.