From dad9162bf9a187ed5f6a83370a73c5019b432e07 Mon Sep 17 00:00:00 2001 From: nruest Date: Thu, 20 Mar 2014 13:28:19 -0400 Subject: [PATCH] README Normalization --- README.md | 65 +++++++++++++++++++++---------------------------------- 1 file changed, 25 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 9226232..380ffda 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,45 @@ -BUILD STATUS ------------- -Current build status: -[![Build Status](https://travis-ci.org/Islandora/islandora_solution_pack_image.png?branch=7.x)](https://travis-ci.org/Islandora/islandora_solution_pack_image) +# Basic Image Solution Pack [![Build Status](https://travis-ci.org/Islandora/islandora_solution_pack_image.png?branch=7.x)](https://travis-ci.org/Islandora/islandora_solution_pack_image) -CI Server: -http://jenkins.discoverygarden.ca +## Introduction -CONTENTS OF THIS FILE ---------------------- +Creates Image Collection to hold image objects. Adds support for Image objects based on JPEG/PNG/GIF image files. - * summary - * requirements - * installation - * configuration - * customization - * troubleshooting - * FAQ - * contact - * sponsors +## Requirements +This module requires the following modules/libraries: -SUMMARY -------- +* [Islandora](https://github.com/islandora/islandora) +* [Tuque](https://github.com/islandora/tuque) +* [ImageMagick](https://drupal.org/project/imagemagick) -Basic Image Solution Pack +*To successfully create derivative data streams ImageMagick (TN & JPG) needs to be installed on the server.* -Creates Image Collection to hold image objects. Adds support for Image objects -based on JPEG/PNG/GIF image files. +## Installation -REQUIREMENTS ------------- +Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) for further information. +## Configuration -INSTALLATION ------------- +Configure the image-tool kit to use ImageMagick rather than GD in Administration » Configuration » Media » Image Toolkit (admin/config/media/image-toolkit). If GD is selected, TN and JPG datastreams will not be generated. +![Configuration](http://i.imgur.com/O3sQPeO.png) -CONFIGURATION -------------- +## Troubleshooting/Issues +Having problems or solved a problem? Check out the Islandora google groups for a solution. -CUSTOMIZATION -------------- +* [Islandora Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora) +* [Islandora Dev Group](https://groups.google.com/forum/?hl=en&fromgroups#!forum/islandora-dev) +## Maintainers/Sponsors +Current maintainers: -TROUBLESHOOTING ---------------- +* [Alan Stanley](https://github.com/ajstanley) +## Development -FAQ ---- +If you would like to contribute to this module, please check out our helpful [Documentation for Developers](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers) info, as well as our [Developers](http://islandora.ca/developers) section on the [Islandora.ca](http://islandora.ca) site. +## License -CONTACT -------- - - -SPONSORS --------- +[GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt)