Skip to content

Commit 0bb9411

Browse files
authored
Update README to clarify JavaScript runtime requirement and link to work type customization docs
1 parent 3e1e45e commit 0bb9411

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Jump in: [![Slack Status](http://slack.projecthydra.org/badge.svg)](http://slack
2828
* [Ruby](#ruby)
2929
* [Redis](#redis)
3030
* [Rails](#rails)
31+
* [JavaScript runtime](#javascript-runtime)
3132
* [Creating a Hyrax\-based app](#creating-a-hyrax-based-app)
3233
* [Generate a work type](#generate-a-work-type)
3334
* [Start servers](#start-servers)
@@ -69,7 +70,7 @@ After installing the Prerequisites:
6970

7071
## Prerequisites
7172

72-
Hyrax 0.0.x requires the following software to work:
73+
Hyrax requires the following software to work:
7374

7475
1. [Solr](http://lucene.apache.org/solr/) version >= 5.x (tested up to 6.4.1)
7576
1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.5.1 (tested up to 4.7.1)
@@ -123,6 +124,10 @@ We recommend the latest Rails 5.0 release.
123124
gem install rails -v 5.0.1
124125
```
125126

127+
### JavaScript runtime
128+
129+
Rails requires that you have a JavaScript runtime -- for example, nodejs -- installed. Either install nodejs or uncomment the `rubyracer` line in your Gemfile and run `bundle install` before running Hyrax's install generator.
130+
126131
# Creating a Hyrax-based app
127132

128133
Generate a new Rails application using the template.
@@ -155,6 +160,8 @@ or
155160
rails generate hyrax:work MovingImage
156161
```
157162

163+
You may wish to [customize your work type](https://github.com/projecthydra/sufia/wiki/Customizing-your-work-types) now that it's been generated.
164+
158165
## Start servers
159166

160167
To test-drive your new Hyrax application in development mode, spin up the servers that Hyrax needs (Solr, Fedora, and Rails):

0 commit comments

Comments
 (0)