updated the manual

[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 6bd8b2fab95825c4d218810fc4d49b893283ae8c..f615732f552e65ebce53590d27b9629d62af49f2 100644 (file)
--- a/src/site/apt/getting-started.apt
+++ b/src/site/apt/getting-started.apt
@@ -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,20 +43,30 @@ $ 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
        
        The Taxonomic Editor uses <maven 3> for convenient configuration and automation of common tasks, 
        such as resolving dependencies and automating builds.
        
-       The <<<trunk>>> branch of the Taxonomic Editor is programmed against the latest
+       The <<<latest snapshot branch>>> of the Taxonomic Editor is programmed against the latest
        SNAPSHOT version of the cdmlibrary. Because that dependency will change quickly, we
        do not imclude it with the other dependencies but rather install it with maven.
 
-       In order to do that you have to run <<<mvn validate>>> in your <<<taxeditor/>>> directory.
+       In order to do that you have to run <<<mvn validate>>> in your <<<taxeditor/eu.etaxonomy.taxeditor.cdmlib>>> directory.
 
 ---
-$ cd taxeditor/
+$ cd taxeditor/eu.etaxonomy.taxeditor.cdmlib/
 $ mvn validate
 ---
 
@@ -65,6 +75,8 @@ $ mvn validate
        
        
        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