From 47bcc56bf381c7eb9bbefe1f98c39fc03fc47191 Mon Sep 17 00:00:00 2001 From: jricher Date: Tue, 12 Jun 2012 10:00:48 -0700 Subject: [PATCH] Updated Build Instructions (markdown) --- Build-Instructions.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/Build-Instructions.md b/Build-Instructions.md index 2a703e9..4232b1c 100644 --- a/Build-Instructions.md +++ b/Build-Instructions.md @@ -1,2 +1,25 @@ -This project uses Maven as its build system. The project makes use of both Git submodules (to include dependencies) and Maven submodules (to organize components), which makes compilation a little tricky. +This project uses Maven as its build system. The project makes use of both Git submodules (to include dependencies on SECOAUTH) and Maven submodules (to organize components), which makes compilation a little tricky. +# Git Checkout and Initialization + +Check out the project using a normal Git clone command: + +`git clone https://github.com/mitreid-connect/OpenID-Connect-Java-Spring-Server.git` + +Change into the newly checked out directory and initialize the Git submodules: + +`git submodule update --init --recursive` + +This will ensure you have a full checkout of both the OpenID Connect project and the SECOAUTH dependency. + +# Building with Maven + +The project uses Maven to build. + +`mvn package` + +# Deploying with Tomcat + +To deploy the Server, copy the generated .war file to the tomcat directory, such as: + +`cp openid-connect-server/target/openid-connect-server.war /var/lib/tomcat6/webapps` \ No newline at end of file