summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDecebal Suiu <decebal.suiu@gmail.com>2014-06-23 11:28:46 +0300
committerDecebal Suiu <decebal.suiu@gmail.com>2014-06-23 11:28:46 +0300
commit88e897e4acd7420c2b0a9f93e4ca0be6a28ddbcb (patch)
treea808b68293aeef2690749d2b0ce92599a90500dc /README.md
parent3e738375dcbdc66f693391341b23cbe0da84d43d (diff)
downloadpf4j-88e897e4acd7420c2b0a9f93e4ca0be6a28ddbcb.tar.gz
pf4j-88e897e4acd7420c2b0a9f93e4ca0be6a28ddbcb.zip
add 'How to build' section in readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index af272d8..f823f44 100644
--- 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
--------------