Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.2 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.2 KB
Raw

Hamidashi

Build Status Code Climate Test Coverage

Detect PDF text overflow.

Requirements

  • ImageMagick

Installation

Add this line to your application's Gemfile:

gem 'hamidashi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hamidashi

Usage

$ hamidashi -h
Hamidashi
=========
Detect PDF text overflow.

Usage:
  exe/hamidashi <name> [--margin=<margin>]
  exe/hamidashi preview <name> [--margin=<margin>] [--page=<page>]
  exe/hamidashi -h | --help
  exe/hamidashi --version

Options:
  -h --help          Show this screen.
  --version          Show version.
  --page=<page>      Show specified page [default: 10].
  --margin=<margin>  Right margin percentage [default: 4.375].

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake false 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/hamidashi. 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 © 2015-2017 YassLab.

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

YassLab