summaryrefslogtreecommitdiff
path: root/lib/scheduling
diff options
context:
space:
mode:
authorAndrewMurrell <amurrel@purdue.edu>2014-04-27 18:25:10 -0400
committerAndrewMurrell <amurrel@purdue.edu>2014-04-27 18:25:10 -0400
commit8b1e26bf00c7e536def47ae4ef3441192f154aa8 (patch)
treed439d299ab281df4c51af06fc3c13bfb416e546c /lib/scheduling
parentc16c1b2928d0156fc00617a6abd81f4714045e5e (diff)
parentcc7faa1bc3a542e0ea057971d37aa400f711d8c0 (diff)
Merge branch 'master' of http://github.com/LukeShu/leaguer
Diffstat (limited to 'lib/scheduling')
-rw-r--r--lib/scheduling/README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/lib/scheduling/README.md b/lib/scheduling/README.md
index 173b7be..8b21164 100644
--- a/lib/scheduling/README.md
+++ b/lib/scheduling/README.md
@@ -1,13 +1,22 @@
-Files in this directory should implement the following interface:
+Scheduling interface
+====================
+
+Files in this directory should be _classes_ implementing the following
+interface:
- `initialize(tournament_stage)`
- construct new Scheduling object from tournament_stage
+
+ Construct new Scheduling object from tournament_stage.
- `create_matches`
- creates all the matches of the current round
+
+ Creates all the matches of the current round.
- `finish_match(match)`
- progresses the match through the schedule
+
+ 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
+
+ Returns a string representation of an svg image of the current
+ stage.