newspaper_works 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0003c7935fbee94e245007e986fcdf7a085bfa5
+  data.tar.gz: 9609ad4d442b7d7630e0231c09bd0592f9828933
+SHA512:
+  metadata.gz: 1522953bfcacedaea668eaf9b59790a6db6ffe3be317ed0e7388a51fa44b4cf3518f463c422f65b5bfedce77ec9731df49f49ea9a0611d5f44041566d596c453
+  data.tar.gz: ddda11224cc5a059c0aa13546ac77805ec1e4e94eae7da2cd9f95eacf4fec8abcc78ec8b68d460939bceed0ce4904cb9b596beca5a20535fa0f83c69554756d4

data/.fcrepo_wrapper

@@ -0,0 +1,4 @@
+# Place any default configuration for solr_wrapper here
+port: 8984
+enable_jms: false
+fcrepo_home_dir: tmp/fcrepo4-development-data

data/.gitignore

@@ -0,0 +1,43 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore Gemfile.lock
+Gemfile.lock
+
+# Ignore coverage reports
+coverage/*
+
+# Ignore bundler config.
+.bundle
+
+# Ignore JetBrains IDE folder
+.idea/*
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+fits.log
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore generated engine_cart testing app:
+.internal_test_app
+
+# Ignore all RubyMine temp files
+.idea/
+
+# Ignore Gemfile.lock
+Gemfile.lock
+
+# Ignore wrapper downloads
+fcrepo-webapp-*

data/.rubocop.yml

@@ -0,0 +1,143 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+RSpec/ExampleLength:
+  Max: 15
+  Exclude:
+    - 'spec/lib/newspaper_works/data/work_derivatives_spec.rb'
+    - 'spec/lib/newspaper_works/ingest/ndnp/issue_ingester_spec.rb'
+
+AllCops:
+  TargetRubyVersion: 2.1
+  DisplayCopNames: true
+  Exclude:
+    - 'db/**/*'
+    - 'script/**/*'
+    - 'spec/test_app_templates/**/*'
+    - 'vendor/**/*'
+
+Lint/ImplicitStringConcatenation:
+  Exclude:
+    - 'lib/generators/newspaper_works/**/*'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/model_shared.rb'
+
+Metrics/BlockLength:
+  ExcludedMethods: ['included']
+  Exclude:
+    - 'newspaper_works.gemspec'
+    - 'lib/tasks/*.rake'
+    - 'spec/**/*.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'spec/model_shared.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/newspaper_works/data/work_derivatives.rb'
+    - 'lib/newspaper_works/ingest/ndnp/page_ingester.rb'
+    - 'lib/newspaper_works/ingest/lc_publication_info.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'lib/generators/newspaper_works/catalog_controller_generator.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'app/helpers/newspaper_works/breadcrumb_helper.rb'
+    - 'lib/generators/newspaper_works/catalog_controller_generator.rb'
+    - 'lib/newspaper_works/page_finder.rb'
+    - 'lib/newspaper_works/ingest/ndnp/ndnp_mets_helper.rb'
+    - 'lib/newspaper_works/ingest/pdf_issue_ingester.rb'
+    - 'spec/model_shared.rb'
+
+Naming/PredicateName:
+  Exclude:
+    - ''
+
+Performance/StringReplacement:
+  Exclude:
+    - 'app/indexers/concerns/newspaper_works/indexes_full_text.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Rails/ApplicationJob:
+  Enabled: false
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+# We define custom methods like `find_by_user_key`,
+# `find_by_created_date`, etc
+Rails/DynamicFindBy:
+  Enabled: false
+
+Rails/FilePath:
+  Exclude:
+    - 'spec/abilities/**/*'
+
+Rails/OutputSafety:
+  Exclude:
+    - 'lib/generators/newspaper_works/templates/config/initializers/patch_blacklight_advanced_search.rb'
+    - 'spec/helpers/newspaper_works_helper_spec.rb'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/abilities/**/*'
+    - 'spec/conversions/**/*'
+    - 'spec/features/**/*'
+    - 'spec/inputs/**/*'
+    - 'spec/views/**/*'
+    - 'spec/lib/tasks/**/*'
+
+# # By default RSpec/MessageSpies has the following:
+# #   Prefer have_received for setting message expectations. Setup form as a spy using allow or instance_spy.
+# # The default assumes EnforcedStyle is 'have_received'. Most of our specs are 'receive'
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/ExpectActual:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MessageExpectation:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false

data/.solr_wrapper

@@ -0,0 +1,8 @@
+# Place any default configuration for solr_wrapper here
+version: 7.7.2
+# port: 8983
+instance_dir: tmp/solr-development
+collection:
+  persist: true
+  dir: .internal_test_app/solr/config/
+  name: hydra-development

data/.travis.yml

@@ -0,0 +1,50 @@
+language: ruby
+dist: xenial
+
+jdk:
+  - openjdk8
+
+addons:
+  chrome: stable
+  apt:
+    sources:
+      - "xenial-media"
+    packages:
+    - ghostscript
+    - graphicsmagick
+    - imagemagick
+    - libreoffice
+    - poppler-utils
+    - tesseract-ocr
+    - libopenjp2-7
+    - libopenjp2-tools
+cache:
+  bundler: true
+
+before_install:
+  - sudo apt-get update -q
+  - gem update --system
+  - gem install bundler
+  - google-chrome-stable --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 http://localhost &
+  - sudo wget -P /opt/install https://brussels.lib.utah.edu/FITS/fits-1.4.1.zip
+  - sudo unzip /opt/install/fits-1.4.1.zip -d /opt/install/fits-1.4.1
+  - sudo chmod +x /opt/install/fits-1.4.1/*.sh
+  - sudo ln -s /opt/install/fits-1.4.1/fits.sh /usr/local/bin/fits.sh
+  - sudo wget -q -O /etc/ImageMagick-6/policy.xml https://raw.githubusercontent.com/marriott-library/newspaper_works/7052ff3bf58022572870a0720d8c5a705090a833/config/vendor/imagemagick-6-policy.xml
+  - sudo wget -q -O /opt/install/fits-1.4.1/xml/fits.xml https://gist.githubusercontent.com/brianmcbride/af3fb21fb50a1331d84eca9a9a170f8f/raw/ebb1a285726e4f5c2309b4f6eceed29fa1369538/fits.xml
+rvm:
+  - 2.5.5
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+    #- ENGINE_CART_RAILS_OPTIONS='--skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-puma --skip-test'
+  # Travis should check every minor version in a range of supported versions, because
+  # rails does not follow sem-ver conventions, see http://guides.rubyonrails.org/maintenance_policy.html
+  # It should be sufficient to test only the latest of the patch versions for a minor version, they
+  # should be compatible across patch versions (only bug fixes are released in patch versions).
+  matrix:
+    - "RAILS_VERSION=5.1.7"
+
+services:
+  - redis

data/Gemfile

@@ -0,0 +1,47 @@
+source 'https://rubygems.org'
+
+# Please see newspaper_works.gemspec for dependency information.
+gemspec
+
+group :development, :test do
+  gem 'coveralls', require: false
+end
+
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 1.2.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      # rubocop:disable Bundler/DuplicatedGem
+      gem 'rails', ENV['RAILS_VERSION']
+      # rubocop:enable Bundler/DuplicatedGem
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+  when /^4.[01]/
+    # rubocop:disable Bundler/DuplicatedGem
+    gem 'sass-rails', '< 5.0'
+    # rubocop:enable Bundler/DuplicatedGem
+  end
+end
+# END ENGINE_CART BLOCK

data/LICENSE

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Boston Public Library
+   Copyright 2019 J. Willard Marriott Library, The University of Utah
+   Additional copyright may be held by others, as reflected in the commit history.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,159 @@
+NewspaperWorks
+===================================================
+Code:
+[![Build Status](https://travis-ci.org/marriott-library/newspaper_works.svg?branch=master)](https://travis-ci.org/marriott-library/newspaper_works) [![Coverage Status](https://coveralls.io/repos/github/marriott-library/newspaper_works/badge.svg)](https://coveralls.io/github/marriott-library/newspaper_works)
+
+Docs:
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./.github/CONTRIBUTING.md)
+
+Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)
+
+<!-- TOC -->
+
+- [Overview](#overview)
+  - [Documentation](#documentation)
+  - [Requirements](#requirements)
+  - [Dependencies](#dependencies)
+- [Installation](#installation)
+  - [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) 
+- [Acknowledgements](#acknowledgements)
+  - [Sponsoring Organizations](#sponsoring-organizations)
+  - [More Information](#more-information)
+  - [Contact](#contact)
+
+<!-- /TOC -->
+
+# Overview
+NewspaperWorks is a gem (Rails "engine") for [Hyrax](https://hyrax.samvera.org/) -based digital repository applications to support ingest, management, and display of digitzed newspaper content.
+
+NewspaperWorks is not a stand-alone application. It is designed to be integrated into a new or existing Hyrax (2.5.x) application, providing content models, ingest workflows, and feature-rich UX for newspaper repository use-cases.
+
+NewspaperWorks supports:
+* models for Title, Issue, Page, and Article
+* batch ingest via command line
+* OCR and ALTO creation
+* newspaper-specific metadata fields
+* full-text search
+* 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).
+
+## 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. 
+
+## Requirements
+
+  * [Ruby](https://rubyonrails.org/) >=2.4
+  * [Rails](https://rubyonrails.org/) ~>5.1
+  * [Bundler](http://bundler.io/)
+  * [Hyrax](https://github.com/samvera/hyrax) ~>2.5
+    - ..._and various [Samvera dependencies](https://github.com/samvera/hyrax#getting-started) that entails_.
+  * A Hyrax-based Rails application
+
+## Dependencies
+
+  * [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/)
+  * [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.
+
+# Installation
+NewspaperWorks easily integrates with your Hyrax 2.5.x applications.
+
+* Add `gem 'newspaper_works'` to your Gemfile.
+* Run `bundle install`
+* Run `rails generate newspaper_works:generate`
+* Set config options as indicated below...
+
+## Application/Site Specific Configuration
+
+### Config changes made by the installer:
+* In `app/controllers/catalog_controller.rb`, the `config.search_builder_class` is set to a new `CustomSearchBuiler` to support newspapers search features.
+* Additional facet fields for newspaper metadata are added to `app/controllers/catalog_controller.rb`.
+* Newspaper resource types added to `config/authorities/resource_types.yml`.
+
+(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` 
+  * 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`
+
+#### in config/environments/production.rb:
+
+* set `config.public_file_server.enabled = true`
+
+# 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
+
+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).
+
+# 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)
+
+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.
+
+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
+
+We encourage anyone who is interested in newspapers and Samvera to contribute to this project. [How can I contribute?](https://github.com/samvera/hyrax/blob/master/.github/CONTRIBUTING.md)
+
+# Acknowledgements
+
+## Sponsoring Organizations
+
+This gem is part of a project developed in a collaboration between [The University of Utah](https://www.utah.edu/), [J. Willard Marriott Library](https://www.lib.utah.edu/) and [Boston Public Library](https://www.bpl.org/), as part of a "Newspapers in Samvera" project grant funded by the [Institute for Museum and Library Services](https:///imls.gov).
+
+The development team is grateful for input, collaboration, and support we receive from the Samvera Community, related working groups, and our project's advisory board.
+
+## More Information
+ * [Samvera Newspapers Group](https://wiki.duraspace.org/display/samvera/Samvera+Newspapers+Interest+Group) - The Samvera Newspapers Interest groups meets on the first Thursday of every month to discuss the Samvera newspapers project and general newspaper topics.
+ * [Newspapers in Samvera IMLS Grant (formerly Hydra)](https://www.imls.gov/grants/awarded/lg-70-17-0043-17) - The official grant award for the project.
+ * [National Digital Newspapers Program NDNP](https://www.loc.gov/ndnp/)
+
+## Contact
+ Contact any contributors above by email, or ping us on [Samvera Community Slack channel(s)](http://slack.samvera.org/)
+
+![Institute of Museum and Library Services Logo](https://imls.gov/sites/default/files/logo.png)
+
+![University of Utah Logo](http://www.utah.edu/_images/imagine_u.png)
+
+![Boston Public Library Logo](https://cor-liv-cdn-static.bibliocommons.com/images/MA-BOSTON-BRANCH/logo.png?1528788420451)
+
+This software has been developed by and is brought to you by the Samvera community.  Learn more at the
+[Samvera website](http://samvera.org/).
+
+![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)