ruby-minigraph

Gem Version test Docs Latest The MIT License DOI

:curly_loop: minigraph - the sequence-to-graph mapper - for Ruby

:construction: under development

Installation

You need to install it from the source code. Because you need to build minigraph and create a shared library. Open your terminal and type the following commands in order.

git clone --recursive https://github.com/kojix2/ruby-minigraph
cd ruby-minigraph
bundle install
bundle exec rake minigraph:build
bundle exec rake install

You can run tests to see if the installation was successful.

bundle exec rake test

Quick Start

require "minigraph"

APIs

Development

git clone --recursive https://github.com/kojix2/ruby-minigraph
# git clone https://github.com/kojix2/ruby-minigraph
# cd ruby-minigraph
# git submodule update -i
cd ruby-minigraph
bundle install
bundle exec rake minigraph:build
bundle exec rake test

Contributing

ruby-minigraph is a library under development and there are many points to be improved. If you improve the source code, please feel free to send us your pull request. Typo corrections are also welcome.

Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/ruby-minigraph.

License

MIT License.