diff options
Diffstat (limited to 'lib/scoring/README.md')
-rw-r--r-- | lib/scoring/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/scoring/README.md b/lib/scoring/README.md new file mode 100644 index 0000000..95dd5e0 --- /dev/null +++ b/lib/scoring/README.md @@ -0,0 +1,10 @@ +Files in this directory should be modules implementing the following +interface: + + - `stats_needed() => Array[i]=Symbol` + Returns which statistics need to be collected for this scoring + algorithm. + + - `score(match) => Hash[User]=Integer` + User scores for this match, assuming statistics have been + collected. |