Chess Openings

Future Ruby gem to calculate Chess Openings from a PGN file (and others)

TODOS:

  • Write documentation
  • Wrap everything up in a Ruby gem
  • Get opening from FEN
  • Make CLI to parse openings from website

Features:

  • Get opening from PGN file
  • Get opening from PGN string
  • Get opening from array with moves
  • Get opening from FEN (maybe?)
  • Search opening by name
  • Get all openings
  • Get all openings that start with some determined moves
  • Get PGN string from an opening
  • Get opening from FEN

Installation

Add this line to your application's Gemfile:

gem 'chess_openings'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chess_openings

Usage

TODO: Write usage instructions here

Development

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/simaoneves/chess_openings/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request