README.md in newspaper_works-0.1.0 vs README.md in newspaper_works-1.0.0
- old
+ new
@@ -1,9 +1,9 @@
NewspaperWorks
===================================================
Code:
-[](https://travis-ci.org/marriott-library/newspaper_works) [](https://coveralls.io/github/marriott-library/newspaper_works)
+[](https://travis-ci.org/samvera-labs/newspaper_works) [](https://coveralls.io/github/samvera-labs/newspaper_works?branch=master)
Docs:
[](./LICENSE)
[](./.github/CONTRIBUTING.md)
@@ -19,11 +19,11 @@
- [Application/Site Specific Configuration](#applicationsite-specific-configuration)
- [Config changes made by the installer:](#config-changes-made-by-the-installer)
- [Configuration changes you should make after running the installer](#configuration-changes-you-should-make-after-running-the-installer)
- [Ingesting Content](#ingesting-content)
- [Developing, Testing, and Contributing](#developing-testing-and-contributing)
- - [Contributing](#contributing)
+ - [Contributing](#contributing)
- [Acknowledgements](#acknowledgements)
- [Sponsoring Organizations](#sponsoring-organizations)
- [More Information](#more-information)
- [Contact](#contact)
@@ -43,14 +43,14 @@
* calendar-based issue browsing
* advanced search
* OCR keyword match highlighting
* viewer with page navigation and deep zooming
-A complete list of features can be found [here](wiki/Features-List).
+A complete list of features can be found [here](https://github.com/samvera-labs/newspaper_works/wiki/Features-List).
## Documentation
-A set of helpful documents to help you learn more and deploy NewspaperWorks can be found on the [Project Wiki](./newspaper_works/wiki), including a PCDM model diagram, metadata schema, batch ingest instructions, and more details on installing, developing, and testing the code.
+A set of helpful documents to help you learn more and deploy NewspaperWorks can be found on the [Project Wiki](https://github.com/samvera-labs/newspaper_works/wiki), including a PCDM model diagram, metadata schema, batch ingest instructions, and more details on installing, developing, and testing the code.
## Requirements
* [Ruby](https://rubyonrails.org/) >=2.4
* [Rails](https://rubyonrails.org/) ~>5.1
@@ -64,14 +64,15 @@
* [FITS](https://projects.iq.harvard.edu/fits/home)
* [Tesseract-ocr](https://github.com/tesseract-ocr/)
* [LibreOffice](https://www.libreoffice.org/)
* [ghostscript](https://www.ghostscript.com/)
* [poppler-utils](https://poppler.freedesktop.org/)
- * [GraphicsMagick](http://www.graphicsmagick.org/)
+ * [ImageMagick](https://github.com/ImageMagick/ImageMagick6)
+ - _ImageMagick policy XML may need to be more permissive in both resources and source media types allowed. See template [policy.xml](config/vendor/imagemagick-6-policy.xml)._
* [libcurl3](https://packages.ubuntu.com/search?keywords=libcurl3)
-See the [wiki](./newspaper_works/wiki/Installing,-Developing,-and-Testing) for more details on how to install and configure dependencies.
+See the [wiki](https://github.com/samvera-labs/newspaper_works/wiki/Installing,-Developing,-and-Testing) for more details on how to install and configure dependencies.
# Installation
NewspaperWorks easily integrates with your Hyrax 2.5.x applications.
* Add `gem 'newspaper_works'` to your Gemfile.
@@ -89,11 +90,11 @@
(It may be helpful to run `git diff` after installation to see all the changes made by the installer.)
### Configuration changes you should make after running the installer:
#### in config/intitializers/hyrax.rb:
-* set `config.geonames_username`
+* set `config.geonames_username`
* Enables geolocation tagging of content
* [how to create a Geonames username](http://www.geonames.org/login)
* set `config.work_requires_files = false`
* set `config.iiif_image_server = true`
* set `config.fits_path = /location/of/fits.sh`
@@ -104,27 +105,27 @@
# Ingesting Content
NewspaperWorks supports a range of different ingest workflows:
* single-item ingest via the UI
-* batch ingest of [NDNP materials](./newspaper_works/wiki/NDNP-Batch-Ingest-Guide) (page-level digitization) via command line
-* batch ingest of [PDF issues](./newspaper_works/wiki/PDF-Batch-Ingest-Guide) via command line
-* batch ingest of [TIFF or JP2 master files](./newspaper_works/wiki/TIFF-or-JP2-Batch-Ingest-Guide) via command line
+* batch ingest of [NDNP materials](https://github.com/samvera-labs/newspaper_works/wiki/NDNP-Batch-Ingest-Guide) (page-level digitization) via command line
+* batch ingest of [PDF issues](https://github.com/samvera-labs/newspaper_works/wiki/PDF-Batch-Ingest-Guide) via command line
+* batch ingest of [TIFF or JP2 master files](https://github.com/samvera-labs/newspaper_works/wiki/TIFF-or-JP2-Batch-Ingest-Guide) via command line
The ingest process creates a full complement of derivatives for each Page object, including:
* TIFF
* JP2
* PDF
* OCR text
* word-coordinate JSON
-For more information on derivatives, see the [wiki](./newspaper_works/wiki/Image-Format-and-Derivative-Notes).
+For more information on derivatives, see the [wiki](https://github.com/samvera-labs/newspaper_works/wiki/Image-Format-and-Derivative-Notes).
# Developing, Testing, and Contributing
-Detailed information regarding development and testing environments setup and configuration can be found [here](./newspaper_works/wiki/Installing,-Developing,-and-Testing)
+Detailed information regarding development and testing environments setup and configuration can be found [here](https://github.com/samvera-labs/newspaper_works/wiki/Installing,-Developing,-and-Testing)
-A Vagrant VM is available for users and developers to quickly and easily deploy the latest NewspaperWorks codebase using Vagrant and VirtualBox. See [samvera-newspapers-vagrant](https://github.com/marriott-library/samvera-newspapers-vagrant) for more.
+A Vagrant VM is available for users and developers to quickly and easily deploy the latest NewspaperWorks codebase using Vagrant and VirtualBox. See [samvera-newspapers-vagrant](https://github.com/samvera-labs/samvera-newspapers-vagrant) for more.
Additionally, the [NewspaperWorks Demo Site](https://newspaperworks.digitalnewspapers.org/) is available for those interested in testing out NewspaperWorks as deployed in a vanilla Hyrax application. (**NOTE:** The demo site may not be running the latest release of NewspaperWorks.)
## Contributing