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 fc8df516b7b436e73e2284f1f0c9e2eb820bd9f6..6edc5a1d858915b72c516f541d68b7c47355c439 100644 (file)
--- a/src/site/apt/getting-started.apt
+++ b/src/site/apt/getting-started.apt
@@ -7,7 +7,7 @@
 
 Setting up a Taxonomic Editor development environment
 
-       This document describes all steps necessarry to create a development environment to develop the EDIT Taxonomic Editor. If you are looking for 
+       This document describes all steps necessary to create a development environment to develop the EDIT Taxonomic Editor. If you are looking for 
        instructions on how to install the EDIT Taxonomic Editor please consult the {{{./manual.html} manual}}.
        
        <Table of Contents>
@@ -16,7 +16,7 @@ Setting up a Taxonomic Editor development environment
        
 * Requirements
 
-       The current version of the EDIT Taxonomic Editor is developed against Eclipse PDE Version 3.6. Your PDE or at least your target platform have to have the same version.
+       The current version of the EDIT Taxonomic Editor is developed against Eclipse Indigo for RCP developers.
        
        
 * Checking out the sources
@@ -43,6 +43,16 @@ $ svn co http://dev.e-taxonomy.eu/svn/trunk/taxeditor
        * Click <Select All> to finish the wizard and import the projects into your workspace.
        
        You should now be able to see the taaxeditor projects in your workspace.
+
+       * The eclipse installation may be missing the following plugins which have to be installed via their update site:
+
+               * <SWTBot> <<API>> plugin from update site: <http://download.eclipse.org/technology/swtbot/releases/latest/>
+
+               * <Modeling-\>><<Graphical Editing Framework Zest Visualization Toolkit SDK>> from update site: <http://download.eclipse.org/releases/indigo>
+
+               * <Nebula Release Individual Widgets-\>> <<Nebula CompositeTable Widget>> from update site: <http://download.eclipse.org/technology/nebula/snapshot>
+
+       * To Install the plugins use the Eclipse-Install-Wizard via <Help -\> Install new Software> and paste the URL in the <Work With> row. Click <Add> and use the Filter to find, check and install plugins.
        
 * Dependencies
        
@@ -60,11 +70,19 @@ $ 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:
        
        
        To get rid of the errors, you have to update the classpaths of all plugin projects. To do this right-click any of the <taxeditor-*> projects and choose <PDE Tools -\> Update Classpath...>. Click <Select All> in the dialog and confirm. After a rebuild of your entire workspace all errors should be gone and you are ready to go.
+
+       <<Note>>: If you have also checked out the cdmlib sources you may have to run <<<mvn install>>> on the cdmlib project beforehand to update the cdmlib jars in your local maven repository.
        
 * Bundle overview
 
@@ -110,7 +128,7 @@ $ mvn validate
 
 ** <eu.etaxonomy.taxeditor.test>
        
-       Automated GUI Tests for the Taxonomic Editor that can be run with {{{http://swtbot.com/}SWTBot}}.
+       Automated GUI Tests for the Taxonomic Editor that can be run with {{{http://eclipse.org/swtbot/}SWTBot}}.
 
 * Creating a launch configuration