oorb

Oorb

OCR Optimized Regex Builder is a command line tool for taking user input and converting it to regular expressions optimized for capturing characters that are commonly mistaken by optical character recognition engines.

Installation as a command line appliction

$ gem install oorb

Installation as part of a Ruby application

Add this line to your application's Gemfile:

gem 'oorb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install oorb

Usage as a command line application

$ oorb

To exit the application, use Ctrl-c.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/rake, bin/rake test, bundle exec rake or bundle exec 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.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/Calvyn82/oorb. 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

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