forked from saulabs/trueskill
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added readme, some doc and cleaned up gem- and rakefile
- Loading branch information
Showing
14 changed files
with
139 additions
and
179 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,5 @@ | ||
## MAC OS | ||
.DS_Store | ||
|
||
## TEXTMATE | ||
*.tmproj | ||
tmtags | ||
|
||
## EMACS | ||
*~ | ||
\#* | ||
.\#* | ||
|
||
## VIM | ||
*.swp | ||
|
||
## PROJECT::GENERAL | ||
coverage | ||
rdoc | ||
pkg | ||
|
||
## PROJECT::SPECIFIC | ||
doc | ||
.yardoc | ||
*.gem |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
source :gemcutter | ||
|
||
gem 'rake', '>= 0.8.7' | ||
gem 'rspec', '>= 1.3.0' | ||
gem 'rcov', '>= 0.9.8' | ||
gem 'yard', '>= 0.5.4' | ||
gem 'yard-rspec', '>= 0.1.0' | ||
gem 'bluecloth', '>= 2.0.5' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
v0.1.0 | ||
------ | ||
|
||
* Initial release of the trueskill gem |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
trueskill | ||
========= | ||
|
||
trueskill is a rating-system for games with an arbitrary number of teams and players developed by Microsoft Research. It is based on the Glicko rating system and solves some major flaws of the ELO system. | ||
|
||
Usage | ||
----- | ||
|
||
Example: | ||
|
||
require 'rubygems' | ||
require 'saulabs/trueskill' | ||
|
||
include Saulabs::TrueSkill | ||
|
||
# team 1 has just one player with a mean skill of 27.1, a skill-deviation of 2.13 | ||
# and an play activity of 100 % | ||
team1 = [Rating.new(27.1, 2.13, 1.0)] | ||
|
||
# team 2 has two players | ||
team2 = [Rating.new(22.0, 0.98, 0.8), Rating.new(31.1, 5.33, 0.9)] | ||
|
||
# team 1 finished first and team 2 second | ||
graph = FactorGraph.new([team1, team2], [1,2]) | ||
|
||
# update the Ratings | ||
graph.update_skills | ||
|
||
Installation | ||
------------ | ||
|
||
To install the TrueSkill gem, simply run | ||
|
||
[sudo] gem install trueskill | ||
|
||
Add the following to your script: | ||
|
||
require 'saulabs/trueskill' | ||
|
||
Known issues | ||
------------ | ||
|
||
* The calculation of the ranking probability is not yet implemented | ||
|
||
Plans | ||
----- | ||
|
||
* | ||
|
||
Note on Patches/Pull Requests | ||
----------------------------- | ||
|
||
* Fork the project. | ||
* Make your feature addition or bug fix. | ||
* Add tests for it. This is important so I don't break it in a | ||
future version unintentionally. | ||
* Commit, do not mess with rakefile, version, or history. | ||
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) | ||
* Send me a pull request. Bonus points for topic branches. | ||
|
||
Copyright | ||
--------- | ||
|
||
© 2010 Lars Kuhnt (<http://saulabs.net>). | ||
|
||
See LICENSE for details. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,24 @@ | ||
require 'rubygems' | ||
require 'rake' | ||
require 'bundler' | ||
|
||
begin | ||
require 'jeweler' | ||
Jeweler::Tasks.new do |gem| | ||
gem.name = "trueskill" | ||
gem.summary = %Q{A ruby library for the trueskill rating system} | ||
gem.description = %Q{A ruby library for the trueskill rating system} | ||
gem.email = "lars.kuhnt@gmail.com" | ||
gem.homepage = "http://github.com/saulabs/trueskill" | ||
gem.authors = ["Lars Kuhnt"] | ||
gem.add_development_dependency "rspec", ">= 1.2.9" | ||
gem.add_dependency('narray', '>= 0.5.9.7') | ||
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings | ||
end | ||
Jeweler::GemcutterTasks.new | ||
rescue LoadError | ||
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler" | ||
end | ||
Bundler.setup | ||
Bundler.require | ||
|
||
require 'spec/rake/spectask' | ||
Spec::Rake::SpecTask.new(:spec) do |spec| | ||
spec.libs << 'lib' << 'spec' | ||
spec.spec_files = FileList['spec/**/*_spec.rb'] | ||
end | ||
|
||
Spec::Rake::SpecTask.new(:rcov) do |spec| | ||
spec.libs << 'lib' << 'spec' | ||
spec.pattern = 'spec/**/*_spec.rb' | ||
spec.rcov = true | ||
end | ||
|
||
task :spec => :check_dependencies | ||
|
||
desc 'Default: run specs.' | ||
task :default => :spec | ||
|
||
require 'rake/rdoctask' | ||
Rake::RDocTask.new do |rdoc| | ||
version = File.exist?('VERSION') ? File.read('VERSION') : "" | ||
desc 'Run the specs' | ||
Spec::Rake::SpecTask.new(:spec) do |t| | ||
t.rcov_opts << '--exclude "gems/*,spec/*"' | ||
t.rcov = true | ||
t.rcov_dir = 'doc/coverage' | ||
t.spec_files = FileList['spec/**/*_spec.rb'] | ||
end | ||
|
||
rdoc.rdoc_dir = 'rdoc' | ||
rdoc.title = "trueskill #{version}" | ||
rdoc.rdoc_files.include('README*') | ||
rdoc.rdoc_files.include('lib/**/*.rb') | ||
YARD::Rake::YardocTask.new(:doc) do |t| | ||
t.files = ['lib/**/*.rb', 'HISTORY.md'] | ||
t.options = ['--no-private', '--title', 'trueskill Documentation', '--readme', 'README.md'] | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
require File.dirname(__FILE__) + '/../../spec_helper' | ||
|
||
describe Saulabs::TrueSkill do | ||
|
||
|
||
|
||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,4 @@ | ||
--color | ||
--format specdoc | ||
--loadby mtime | ||
--reverse |
Oops, something went wrong.