more documentation and some cleanup

[progcomp10.git] / src / README.txt

diff --git a/src/README.txt b/src/README.txt
new file mode 100644 (file)
index 0000000..2dae87d
--- /dev/null
+++ b/src/README.txt
@@ -0,0 +1,24 @@
+Hi there,
+
+You've reached the source directory of the UCC::ProgComp 2010.
+
+For documentation, see the contents of the "doc" directory.
+
+The first thing you'll probably want to do is see it work. Try running:
+
+./simulate -v
+
+to see the sample agents duke it out.
+
+This is a brief overview of the included files and directories:
+ - SampleAgents.py : the sample agents. This is the bit you care about!
+ - arenas/ : arenas define which agents play against which, and some other parameters.
+ - link/ : Other languages belong here.
+ - conf.py : has various useful things like the ability to turn on debug support.
+
+The rest of the files are probably not useful to you, but just for completeness:
+ - simulate.py : run a simulation.
+ - uccProgComp.py : the guts of the competition.
+ - rpsconst.py : various constants, such as the points table.
+
+Ignore anything else. :P
\ No newline at end of file