Skip to content

yasslab/docset

Repository files navigation

Docset

Build Status

A library for Dash docset generation.

Installation

Add this line to your application's Gemfile:

gem 'docset'

And then execute:

$ bundle

Or install it yourself as:

$ gem install docset

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yasslab/docset. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

Copyright © 2017 YassLab.

The gem is available as open source under the terms of the MIT License.

YassLab