/argyle

Primary LanguageRubyMIT LicenseMIT

Argyle

Tests Rubocop codecov Codacy Badge


Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/argyle. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

--- ??? ---

Installation

Add this line to your application's Gemfile:

Requires ncurses or ncursesw (with wide character support). On Debian based distributions, you can install it with apt:

$ apt install libncurses5-dev

Or

$ apt install libncursesw5-dev

gem 'argyle'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install argyle

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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, 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/[USERNAME]/argyle.

License

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