Rubidex is a gem that helps manage an index of symbols in your Ruby project, including generating derived data like 'ctags' files.
Add this line to your application's Gemfile:
gem 'rubidex'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install rubidex
TODO: Write usage instructions here
After checking out the repo, run script/setup
to install dependencies. Then, run rake test
to run the tests. You can also run script/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.
Bug reports and pull requests are welcome on GitHub at https://github.com/anurse/rubidex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Rubidex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.