This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version; I am using: ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-linux]
-
System dependencies: see Hyrax/Samvera wiki
-
Configuration: Fedora Commons 4 Solr 6.4.1
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions I started with Hyrax Samvera hydra-works-demo instructions and amended blacklight.yml, fedora.yml and solr.yml to move away from fedora_wrapper and solr_wrapper
-
...