]> source.dussan.org Git - pf4j.git/commitdiff
add 'How to build' section in readme
authorDecebal Suiu <decebal.suiu@gmail.com>
Mon, 23 Jun 2014 08:28:46 +0000 (11:28 +0300)
committerDecebal Suiu <decebal.suiu@gmail.com>
Mon, 23 Jun 2014 08:28:46 +0000 (11:28 +0300)
README.md

index af272d82c431370e781899eb6dd36a62420bb807..f823f44f411bf3068d067c6e20bfedb5f549210a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -273,6 +273,20 @@ To run the demo application use:
     ./run-demo.sh (for Linux/Unix)
     ./run-demo.bat (for Windows)
 
+How to build
+-------------------
+Requirements: 
+- [Git](http://git-scm.com/) 
+- JDK 1.7 (test with `java -version`)
+- [Apache Maven 3](http://maven.apache.org/) (test with `mvn -version`)
+
+Steps:
+- create a local clone of this repository (with `git clone https://github.com/decebals/pf4j.git`)
+- go to project's folder (with `cd pf4j`) 
+- build the artifacts (with `mvn clean package` or `mvn clean install`)
+
+After above steps a folder _pf4j/target_ is created and all goodies are in that folder.
+
 Mailing list
 --------------