improved build instructions based on feedback/questions

geotools · May 25, 2017 · 9141bfa · 9141bfa
1 parent ca0e7eb
commit 9141bfa
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/docs/user/build/maven/build.rst b/docs/user/build/maven/build.rst
@@ -8,11 +8,11 @@ Your First Build
 
 1. Start by going to where you have the source code::
 
-     cd C:\java\geotools\trunk
+     cd C:\java\geotools
 
 2. And check that we actually have the source code::
 
-     C:\java\geotools\trunk>dir
+     C:\java\geotools>dir
       Volume in drive C is INTERNAL
       Volume Serial Number is 3CA5-71DD
       Directory of C:\java\geotools\trunk
@@ -32,7 +32,7 @@ Your First Build
 3. Make sure you are connected to the internet
 4. Start your first build::
 
-     C:\java\geotools\trunk>mvn install
+     C:\java\geotools>mvn install
 
 5. If all is well, Maven should download the required .jar files and build GeoTools modules.
 6. At the end of this process it will display a list of all the modules which were built and installed correctly.::

diff --git a/docs/user/build/maven/eclipse.rst b/docs/user/build/maven/eclipse.rst
@@ -5,21 +5,29 @@ Maven can be used to work with the Eclipse IDE. While direct integration is curr
 Creating .project and .classpath files
 
 You can use maven to set up the files needed for eclipse::
-   
-   mvn eclipse:eclipse -DoutputDirectory=bin -Dall
+
+   mvn eclipse:eclipse
 
 This will produce the following files for each module:
 * .classpath file
 * .project file
 
-The way to read the above line is we are using the eclipse plugin, and we are asking it to do the goal eclipse. The other options are to specify a default output directory (so that eclipse and maven do not both use target/classes and trip on each other). The -Dall switch is used to include the unsupported modules.
+The way to read the above line is we are using the eclipse plugin, and we are asking it to do the goal eclipse. The -Dall switch is used to include the unsupported modules.
 
 If you like you can just do a simple::
    
    C:\java\geotools\trunk\>mvn eclipse:eclipse
 
 Because maven and eclipse will both use **target/classes** you will need to perform a clean when switching between maven and eclipse for building.
 
+.. note::
+
+   If you would like maven command line and eclipse IDE to use different output directories::
+    
+      mvn eclipse:eclipse -DoutputDirectory=bin -Dall
+   
+   The other options are to specify a default output directory (so that eclipse and maven do not both use target/classes and trip on each other).
+
 You can then import all the GeoTools projects into your Eclipse IDE.
 
 Customising the Name of the Generated Projects