README.md in hydra-derivatives-3.4.2 vs README.md in hydra-derivatives-3.5.0
- old
+ new
@@ -1,21 +1,21 @@
# hydra-derivatives
Code:
[![Version](https://badge.fury.io/rb/hydra-derivatives.png)](http://badge.fury.io/rb/hydra-derivatives)
-[![Build Status](https://travis-ci.org/samvera/hydra-derivatives.png?branch=master)](https://travis-ci.org/samvera/hydra-derivatives)
+[![Build Status](https://circleci.com/gh/samvera/hydra-derivatives.svg?style=svg)](https://circleci.com/gh/samvera/hydra-derivatives)
[![Coverage Status](https://coveralls.io/repos/github/samvera/hydra-derivatives/badge.svg?branch=master)](https://coveralls.io/github/samvera/hydra-derivatives?branch=master)
Docs:
[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE.txt)
Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
# What is hydra-derivatives?
-Derivative generation for hydra
+Derivative generation for Samvera applications.
## Product Owner & Maintenance
**hydra-derivatives** is a Core Component of the Samvera community. The documentation for
what this means can be found
@@ -210,9 +210,40 @@
- If no `:recipe` is provided the processor will examine the image and make a best guess, but you can set a few basic options (the remainder of this list). Note that these are ignored if you provided a recipe via either of the first two methods described.
* `:levels` (Integer) : The number of decomposition levels. The default is the number of times the long dimension can be divided by two, down to 96, e.g. a 7200 pixel image would have 6 levels (3600, 1800, 900, 450, 225, 112)
* `:layers` (Integer) : The number of quality layers. Default: 8
* `:compression` (Integer) : The left number of the compression ratio `n:1`, e.g. 12 will apply 12:1 compression. Default: 10.
* `:tile_size` (Integer) : Pixel dimension of the tiles. Default: 1024
+
+# Development Environment
+
+## Dependencies
+
+* [ImageMagick](https://www.imagemagick.org)
+ * On a mac, do `brew install imagemagick`
+* [LibreOffice](https://www.libreoffice.org/)
+* * On a mac, do `brew cask install libreoffice`
+* [Kakadu](http://kakadusoftware.com/)
+ * On a mac, extract the file and run the pkg installer therein (don't get distracted by the files called kdu_show)
+* [Ghostscript](https://www.ghostscript.com/)
+ * On a mac, `brew install ghostscript`
+* ufraw
+ * On a mac, `brew install ufraw`
+* libvpx
+ * On a mac, `brew install libvpx`
+* ffmpeg
+ * On a mac, `brew install ffmpeg`
+ * Ensure `libvpx` is installed first
+
+## Running Tests
+
+1. Run tests with `RAILS_ENV=test bundle exec rake ci`
+
+## Running specific tests
+
+If you don't want to run the whole suite all at once like CI, do the following:
+
+1. Run the test servers with `rake derivatives:test_server`
+2. Run the tests.
# Acknowledgments
This software has been developed by and is brought to you by the Samvera community. Learn more at the
[Samvera website](http://samvera.org/).