Contributing

  1. Relevant Links
  2. Building From Source
  3. Documentation
  4. Open Issues

By all means.

Building From Source

To make life easier, you can use Bundler with the included Gemfile to load all the necessary development dependencies.

For example, to install all the dependencies and run the test suite for the first time:

$ bundle install
$ bundle exec rake test

Documentation

Documentation is written in Textile, and converted to HTML using Jekyll.

API reference is RDoc, converted to HTML using Yardoc.

To build and view documentation:

$ rake docs
$ open html/index.html

Open Issues