aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md53
1 files changed, 42 insertions, 11 deletions
diff --git a/readme.md b/readme.md
index 497088e..cd155bb 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,19 @@
# MOA ZS
-## Prepare Repo
+## Prepare for Compilation
-Some dependencies are not in the mvn central repo. You need to install
-those dependencies to your local maven repository with `mvn install`.
-Check `pom.xml` and follow the instructions.
+For compiling MOAZS, do the following:
+1. Checkout MoaZS repository (directory name `moazs.git`)
+2. Install `at.gv.egiz.eaaf.eaaf_module_moa-sig` to local repository.
+3. Install `at.gv.util.egovutils` to local mvn repository.
+4. Make `eaaf_module_moa-sig`'s transitive dependencies available by copying or symlinking `eaaf_module_moa-sig`'s repository into MOAZS repository.
-## How to install `eaaf_module_moa-sig`
+Certain artifacts are not in the mvn central repo. You need to
+install those articats to your local maven repository.
+
+### How to Install `at.gv.egiz.eaaf.eaaf_module_moa-sig`
+
+Requirements: JDK 1.8
```
export EAAF_COMPONENTS_VERSION=1.0.7
@@ -14,16 +21,40 @@ cd /path/to/working/dir
git clone https://gitlab.iaik.tugraz.at/egiz/eaaf_components/
cd eaaf_components
git checkout $EAAF_COMPONENTS_VERSION
-mvn package javadoc:jar sources:jar
-mvn install:install-file -DgroupId=at.gv.egiz.eaaf -DartifactId=eaaf_module_moa-sig \
- -Dversion=$EAAF_COMPONENTS_VERSION -Dpackaging=jar \
- -Dfile=eaaf_modules/eaaf_module_moa-sig/target/eaaf_module_moa-sig-$EAAF_COMPONENTS_VERSION.jar \
- -Djavadoc=eaaf_modules/eaaf_module_moa-sig/target/eaaf_module_moa-sig-$EAAF_COMPONENTS_VERSION-javadoc.jar \
- -Dsources=eaaf_modules/eaaf_module_moa-sig/target/eaaf_module_moa-sig-$EAAF_COMPONENTS_VERSION-sources.jar
+mvn clean package source:jar install
+```
+### How to Install `at.gv.util.egovutils`
+
+Requirements: JDK 1.8
+
+```
+export EGOV_UTILS_VERSION=2.0.7-snapshot
+cd /path/to/working/dir
+git clone https://gitlab.iaik.tugraz.at/egiz/egovutils
+cd egovutils
+git checkout $EGOV_UTILS_VERSION
+mvn clean package install
+```
+
+### Workaround: Make eaaf_module_moa-sig's Transitive Dependencies Available
+
+`eaaf_module_moa-sig` depends on artifacts that are also not in mvn's
+central repo. You can make them available by copying or symlinking to
+the repository directory in
+https://gitlab.iaik.tugraz.at/egiz/eaaf_components/tree/master/eaaf_modules/eaaf_module_moa-sig/repository
+
+```
+cd moazs.git
+# symlink to moa sig's artifacts
+ln -s <path-to-local-eaaf-components-git-repo>/eaaf_modules/eaaf_module_moa-sig/repository
+# copy repository
+cp <path-to-local-eaaf-components-git-repo>/eaaf_modules/eaaf_module_moa-sig/repository .
```
## Compile & Test
+Requirements: openJDK 11
+
```
mvn test
```