Updated Build Instructions (markdown)

master
jricher 2012-06-12 10:00:48 -07:00
parent 55e69d8a3c
commit 47bcc56bf3
1 changed files with 24 additions and 1 deletions

@ -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`