Merge pull request #7 from ualbertalib/master

Add new README.
web-archive-group · Jun 7, 2016 · 1263fde · 1263fde
2 parents e830344 + ed239d2
commit 1263fde
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+BlacklightWALK
+==============
+
+# H3 Blacklight instance operating on [WALK webarchiving
+data](http://webarchives.ca/).
+
+To install (developers):
+
+1. Requirements: [Git](https://git-scm.com/), [Ruby](https://www.ruby-lang.org/en/), [Rails](http://rubyonrails.org/), [Bundler](http://bundler.io/), [Java](https://java.com/en/download/), Javascript runtime
+   (i.e. [Node.js](https://nodejs.org/en/))
+2. Clone this repo. (e.g. `git clone
+   http://github.com/web-archive-group/BlacklightWALK`)
+3. `cd BlacklightWalk`
+4. `bundle install`
+5. `rake db:migrate`
+
+To use the bundled Solr index:
+6. Copy a Solr index of WALK data into `jetty/solr/discovery/data/index`
+7. Run `rake jetty:start`
+
+To use standalone Solr
+6. Edit `config/blacklight.yml` to use the URL of the Solr index.
+
+Run `rails s` to start the application.
+
+
diff --git a/README.rdoc b/README.rdoc