diff README.md @ 1656:68f65786003e

Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
author Robert Casties <r0bcas7@gmail.com>
date Mon, 20 Nov 2017 16:59:28 +0100
parents 22dd14eccdc0
children 28df291d4e26
line wrap: on
line diff
--- a/README.md	Tue Nov 14 18:41:22 2017 +0100
+++ b/README.md	Mon Nov 20 16:59:28 2017 +0100
@@ -33,6 +33,31 @@
 or on [SourceForge](https://sourceforge.net/projects/digilib/)
 
 * [Source code](https://github.com/robcast/digilib)
+* [Issue tracker](https://github.com/robcast/digilib/issues)
 * Daily built [WAR files](https://it-dev.mpiwg-berlin.mpg.de/downloads/digilib/daily-build/)
 * Daily built [Javadoc](https://it-dev.mpiwg-berlin.mpg.de/downloads/digilib/daily-build/javadoc/)
 * [Maven repository](http://it-dev.mpiwg-berlin.mpg.de/maven-repo/)
+
+## How do I run digilib?
+
+Requirements:
+* [git](https://git-scm.com/)
+* [Java JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+* [Maven](https://maven.apache.org/)
+
+Build:
+1. Clone the digilib repository
+
+   `git clone https://github.com/robcast/digilib.git`
+
+2. Change to the repository
+
+   `cd digilib`
+   
+3. build and run the webapp in the embedded Jetty runtime for development
+ 
+   `mvn jetty:run --projects webapp`
+   
+   and watch digilib at http://localhost:8080/digilib.html
+
+or follow the production build instructions in the on https://robcast.github.io/digilib/