summaryrefslogtreecommitdiff
path: root/lib/scheduling/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/scheduling/README.md')
-rw-r--r--lib/scheduling/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/scheduling/README.md b/lib/scheduling/README.md
new file mode 100644
index 0000000..fe6aba1
--- /dev/null
+++ b/lib/scheduling/README.md
@@ -0,0 +1,22 @@
+Scheduling interface
+====================
+
+Files in this directory should be _classes_ implementing the following
+interface:
+
+ - `initialize(TournamentStage)`
+
+ 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.