adding note on using the localrepository profile

[taxeditor.git] / src / site / apt / getting-started.apt

diff --git a/src/site/apt/getting-started.apt b/src/site/apt/getting-started.apt
index 67e5232cd438d76d030bf6254f9616ed1b453381..6edc5a1d858915b72c516f541d68b7c47355c439 100644 (file)
--- a/src/site/apt/getting-started.apt
+++ b/src/site/apt/getting-started.apt
@@ -70,6 +70,12 @@ $ cd taxeditor/eu.etaxonomy.taxeditor.cdmlib/
 $ mvn validate
 ---
 
+    The maven pom.xml provides a special profile which you may want to use if you are developing the cdmlib at the same time. This profile, named <<<local-repository>>>, causes maven to always use the local maven repository, so the latest changes to the cdmlib which have been installed locally by <<<mvn install>>>  will be used. In order to use this profile you would execute the validate gloal differently:
+
+ ---
+ $ mvn -P local-repository  -Dlocalrepo=/home/${youUserName}/.m2/repository validate
+ ---
+
        This will take some time, as maven will download the required dependencies.
        After maven has finished follow these steps: