From d84ce436760ad61c7b992fbdaa239cb84da1439f Mon Sep 17 00:00:00 2001 From: Simon Ebner Date: Tue, 17 Dec 2013 14:56:59 +0100 Subject: [PATCH] Update readme --- ch.psi.fda/Readme.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/ch.psi.fda/Readme.md b/ch.psi.fda/Readme.md index 3b6e709..1a9aee4 100644 --- a/ch.psi.fda/Readme.md +++ b/ch.psi.fda/Readme.md @@ -1,11 +1,7 @@ -# Development +# Overview +This package holds the core functionality of FDA. -## Build -To build project use `mvn clean install`. - -To upload the latest version to the central artifact repository use `mvn clean deploy`. - -## Usage +# Usage To use the FDA libary in an other project use: @@ -16,3 +12,12 @@ To use the FDA libary in an other project use: x.x.x ``` + + +# Development +When checking out the project from the repository there is the `target/generated-sources/xjc` folder missing. +After checking out the project execute `mvn compile` to create the folder and the required classes. + +To build project use `mvn clean install`. + +To upload the latest version to the central artifact repository use `mvn clean deploy`. \ No newline at end of file