Skip to content

Commit

Permalink
update readme [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
mnyrop committed Sep 10, 2019
1 parent 3cd40e4 commit c72008b
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,48 @@

This fork is *mostly* a copy of the [iiif_s3 gem](https://github.com/cmoa/iiif_s3) with all the s3 dependencies and functionality removed. It creates level 0 IIIF derivatives for static exhibition sites with [Minicomp/Wax](https://github.com/minicomp/wax/) via [Wax_Tasks](https://github.com/minicomp/wax_tasks/).

## Installation

This library assumes that you have ImageMagick installed. If you need to install it, follow the instructions:

on OSX, `brew install imagemagick ` should be sufficient.

If you have issues with TIFF files, try

```shell

brew update
brew reinstall --with-libtiff --ignore-dependencies imagemagick

```

If you plan to work with PDFs, you should also have a copy of GhostScript installed.

on OSX, `brew install gs`



Add this line to your application's Gemfile:

gem 'wax_iiif'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wax_iiif

## Usage

Documentation for using `wax_iiif` without `wax_tasks` is forthcoming. In the meantime, check out [rubydoc](https://www.rubydoc.info/gems/wax_iiif).


## Contributing

1. Fork it ( https://github.com/minicomp/wax_iiif/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

0 comments on commit c72008b

Please sign in to comment.