https://github.com/minicomp/wax_iiif

Minimal IIIF level 0 generator (iiif_s3 minus the s3) 🐝
https://github.com/minicomp/wax_iiif

Last synced: about 1 year ago
JSON representation

Minimal IIIF level 0 generator (iiif_s3 minus the s3) 🐝

• Host: GitHub
• URL: https://github.com/minicomp/wax_iiif
• Owner: minicomp
• License: other
• Created: 2018-11-11T01:07:48.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-10-03T19:20:33.000Z (over 2 years ago)
• Last Synced: 2025-03-27T02:11:21.236Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 3.8 MB
• Stars: 8
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# wax_iiif

[![Gem Version](https://badge.fury.io/rb/wax_iiif.svg)](https://badge.fury.io/rb/wax_iiif)

[![ci:test](https://github.com/minicomp/wax_iiif/actions/workflows/ci.yml/badge.svg)](https://github.com/minicomp/wax_iiif/actions/workflows/ci.yml)

[![Maintainability](https://api.codeclimate.com/v1/badges/a7d79a1b819cef81eb11/maintainability)](https://codeclimate.com/github/minicomp/wax_iiif/maintainability)

![License](https://img.shields.io/badge/license-MIT-green.svg) [![docs](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](https://www.rubydoc.info/github/minicomp/wax_iiif/)  

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