diff options
| author | Luke Shumaker <shumakl@purdue.edu> | 2014-04-27 18:22:19 -0400 |
|---|---|---|
| committer | Luke Shumaker <shumakl@purdue.edu> | 2014-04-27 18:22:19 -0400 |
| commit | cc7faa1bc3a542e0ea057971d37aa400f711d8c0 (patch) | |
| tree | 598bd26c9cac3eef04578e05f6f84f0fd720a256 /lib/scheduling | |
| parent | 63e8f63b1a65247f7b272236af20fddaba96ef1e (diff) | |
tidy up README.md's
Diffstat (limited to 'lib/scheduling')
| -rw-r--r-- | lib/scheduling/README.md | 19 |
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. |