Merge branch 'c-agents'

* c-agents:
  C++ documentation
  C documentation
  documentation to support uuid passing
  Implemented UUID passing in externAgent and C. Enabled externAgents to print debug messages to stderr
  Fixed UUID string length (curse you python)
  Added support for HI command (C can now see UUID)
  changed externAgent so as to never permit more than MAX_TOTAL_AGENTS to exist
  applied TPG's patch, fixed wash

diff --git a/doc/NOTES.txt b/doc/NOTES.txt
new file mode 100644 (file)
index 0000000..7e73ad6
--- /dev/null
+++ b/doc/NOTES.txt
@@ -0,0 +1,7 @@
+NOTES.txt: development notes; issues that will be fixed in coming updates. hopefully.
+
+ - number of agents can spiral out of control very quickly, e.g. if Wash and Angel start duking it out.
+   * Need to make supervisor smart enough to kill monotonically increasing sequences.
+   * Currently it can cap the number of bots; not sure if it does it in a fair way. It's presently entirely opportunistic; if you happen to be having a kid when the arena's full, you just silently fail and keep your points. This could result in an agent being able to spawn with 101 points if a gap comes up at the right time, while a 201 point agent isn't able to because he/she doesn't get in on time. Is this fair?
+
+ - Python code seems to trust you not to monkey around with your stats...? Will definitely be fixed before judging.

diff --git a/doc/README.txt b/doc/README.txt
index 79cbce7..5a13975 100644 (file)
--- a/doc/README.txt
+++ b/doc/README.txt
@@ -3,13 +3,28 @@
 Congratulations, you've found the documentation!
 
  - WELCOME.txt: A general introduction to the competition.
- - HOWTO.txt: A guide to getting the software you need to compete, and making your first baby steps towards competing.
+
+ - HOWTO.txt: A guide to getting the software you need to compete, and 
+making your first baby steps towards competing.
+
  - POINTS.txt: The points table.
- - JUDGING.txt: An insight into the capricious and arbitrary mind of the organiser on how your agent will be judged.
+
+ - JUDGING.txt: An insight into the capricious and arbitrary mind of the 
+organiser on how your agent will be judged.
+
  - http://progcomp.ucc.asn.au/Rules : the rules of the competition
+
  - http://progcomp.ucc.asn.au/FAQs : Frequently Asked Questions
+
  - http://progcomp.ucc.asn.au/More%20Info : General Info
- - NOTES.txt: possibly important stuff that doesn't fit anywhere else.
- - INTERNALS.txt: Internal information which might interest you but which you shouldn't rely upon.
- - UNSUPPORTED.txt: The wire protocol - useful for debugging. Also contains details on how to use a language that isn't Python, C/C++, Java or Octave/Matlab.
- - LICENSE: the terms under which the code is released to you.
\ No newline at end of file
+
+ - NOTES.txt: development notes. Not for general consumption.
+
+ - INTERNALS.txt: Internal information which might interest you but 
+which you shouldn't rely upon.
+
+ - UNSUPPORTED.txt: The wire protocol - useful for debugging. Also 
+contains details on how to use a language that isn't Python, C/C++, Java 
+or Octave/Matlab.
+
+ - LICENSE: the terms under which the code is released to you.

diff --git a/issues.txt b/issues.txt
deleted file mode 100644 (file)
index a4dfcf0..0000000
--- a/issues.txt
+++ /dev/null
@@ -1,8 +0,0 @@
- - number of agents can spiral out of control very quickly, e.g. if Wash and Angel start duking it out.
-   * Need to make supervisor smart enough to kill monotonically increasing sequences.
-   * Currently it can cap the number of bots; not sure if it does it in a fair way. It's presently entirely opportunistic; if you happen to be having a kid when the arena's full, you just silently fail and keep your points. This could result in an agent being able to spawn with 101 points if a gap comes up at the right time, while a 201 point agent isn't able to because he/she doesn't get in on time. Is this fair?
-
- - Python code seems to trust you not to monkey around with your stats...?
-
- - coding styles are inconsistent throughout
- - layout still needs some work

diff --git a/src/USINGPYTHON.txt b/src/USINGPYTHON.txt
index 432aa9b..395a33e 100644 (file)
--- a/src/USINGPYTHON.txt
+++ b/src/USINGPYTHON.txt
@@ -1,4 +1,6 @@
-USINGPYTHON.txt: A 10 step guide to writing an agent in Python.
+USINGPYTHON.txt: An 11 step guide to writing an agent in Python.
+
+0. Watch the sample agents in action and flick through the documentation.
 
 1. Pick a name for your agent. Make sure the name is a valid python 
 identifier. Be original.