summaryrefslogtreecommitdiff
path: root/lib/scheduling/README.md
diff options
context:
space:
mode:
authorAndrewMurrell <amurrel@purdue.edu>2014-04-26 22:47:58 -0400
committerAndrewMurrell <amurrel@purdue.edu>2014-04-26 22:47:58 -0400
commitab25aac502a768b6a530ada5c46d6aabe6a56c4c (patch)
treec36e8f6d6fa24f2db907b78b23301fdbd7973b9c /lib/scheduling/README.md
parent2c1e5ab5e7b20dabec9ddb9b34e0cf534afc6d06 (diff)
Added READMEs for scheduling and started seeding in lib.
Diffstat (limited to 'lib/scheduling/README.md')
-rw-r--r--lib/scheduling/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/scheduling/README.md b/lib/scheduling/README.md
new file mode 100644
index 0000000..173b7be
--- /dev/null
+++ b/lib/scheduling/README.md
@@ -0,0 +1,13 @@
+Files in this directory should implement the following interface:
+
+ - `initialize(tournament_stage)`
+ construct new Scheduling object from tournament_stage
+
+ - `create_matches`
+ creates all the matches of the current round
+
+ - `finish_match(match)`
+ progresses the match through the schedule
+
+ - `graph`
+ returns a string representation of an svg image of the current stage \ No newline at end of file