summaryrefslogtreecommitdiff
path: root/lib/scheduling/README.md
diff options
context:
space:
mode:
authornfoy <nfoy@purdue.edu>2014-04-26 23:45:25 -0400
committernfoy <nfoy@purdue.edu>2014-04-26 23:45:25 -0400
commit6f19b51f0adf95b1d9bd8317388ecdbcb3756be7 (patch)
treec4be583ba9db126ef58db7a1900468ec0929df25 /lib/scheduling/README.md
parent9d8d6b023ce3390f3ccf9808e630505a15ebebe6 (diff)
parent9dd899559e4533c61089c3f9429574d2de20925e (diff)
Merge branch 'master' of https://github.com/LukeShu/leaguer
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