Updated documentation for our ADE development webpage:

-added notes about running as root when applicable
-added a note to check for libGLU package (because this was an issue I encountered when creating a ADE VM from scratch)
-alphabetized our git clone list and added the goesr repo
-added note about switching branches if desired, before importing into eclipse
-updated the command for running eclipse (no longer has '.sh' on executable)
-Reformated section 5 to have subsections/subheaders
-made paths more specific in section 5 so there is no confusion on where settings are to be found
-added screenshots for importing git repos and cleaning workspace
-reformated section 6 to have subsections/headers
-added screenshots for clarity

docs/dev/awips-development-environment.md

@@ -8,6 +8,8 @@ Quick instructions on how to download the latest source code and run CAVE from E
 
 First, make sure to remove any instances of AWIPS that are already installed, this can potentially cause problems when setting up the development environment.  Below is an example that had CAVE installed.
 
+!!! note "The following may need to be run as *root* user."
+
 Uninstall with yum:
 
     yum clean all
@@ -41,11 +43,15 @@ proxy=_none_
 
 ## 3. Install the ADE
 
+!!! note "The following may need to be run as *root* user."
+
 Install the AWIPS Development Environment (ADE) using yum.  This will install Eclipse (4.6.1), Java (1.8), Ant (1.9.6), Python 2.7 and its modules (Numpy, Matplotlib, Shapely, Jep, and others). 
 
     yum clean all
     yum groupinstall awips2-ade
 
+!!! note "Check the libGLU package is installed by running `rpm -qa | grep mesa-libGLU`.  If nothing is returned, install the package via: `yum install mesa-libGLU`."
+
 ---
 
 ## 4. Download the Source Code
@@ -57,69 +63,102 @@ If it's not already installed, install git:
 Next clone all of the required repositories for AWIPS:
     
     git clone https://github.com/Unidata/awips2.git
+    git clone https://github.com/Unidata/awips2-cimss.git
     git clone https://github.com/Unidata/awips2-core.git
     git clone https://github.com/Unidata/awips2-core-foss.git
+    git clone https://github.com/Unidata/awips2-drawing.git
     git clone https://github.com/Unidata/awips2-foss.git
+    git clone https://github.com/Unidata/awips2-goesr.git
+    git clone https://github.com/Unidata/awips2-gsd.git
     git clone https://github.com/Unidata/awips2-ncep.git
     git clone https://github.com/Unidata/awips2-nws.git
-    git clone https://github.com/Unidata/awips2-gsd.git
+    
-    git clone https://github.com/Unidata/awips2-drawing.git
+!!! note "Make sure to run `git checkout` in each repo if you'd wish to develop from a branch different from the default.  It's best to do this before importing the repos into eclipse."
-    git clone https://github.com/Unidata/awips2-cimss.git
 
 ---
 
-## 5. Set Up Eclipse
+## 5. Configure Eclipse
 
-Open eclipse by running: `/awips2/eclipse/eclipse.sh`
+Open eclipse by running: `/awips2/eclipse/eclipse`
+
+It is fine to choose the default workspace upon starting up.
+
+### Set Preferences
 
 Verify or make the following changes to set up eclipse for AWIPS development:
 
-* Preferences > Java 
+1. Window > Preferences > Java > Installed JREs
     
-    Set to **/awips2/java**
+     * Set to **/awips2/java**
 
-* Preferences > PyDev > Python Interpreter
+1. Window > Preferences > PyDev > Interpreters > Python Interpreter
 
-    Set to **/awips2/python/bin/python**
+      * Set to **/awips2/python/bin/python**
     
-* There might be some unresolved errors.  These should be made to warnings instead.
+        > Note: Add all paths to the SYSTEM pythonpath if prompted
     
-    Preferences > Java > Compiler > Building > **Circular Dependencies** > Change to Warning
+1. There might be some unresolved errors.  These should be made to warnings instead.
-    Preferences > Plug-in Development > API Baselines > **Missing API Baseline** > Change to Warning
 
-* **Turn off automatic building** (you will turn this back on after importing the repos)
+      * Window > Preferences > Java > Compiler > Building > Build path Problems > **Circular Dependencies** > Change to Warning
+      * Window > Preferences > Plug-in Development > API Baselines > **Missing API Baseline** > Change to Warning
     
-    Project > Uncheck "Build Automatically"
+1. **Turn off automatic building** (you will turn this back on after importing the repos)
     
-* File > Import > General > Existing Projects Into Workspace
+      * Project > Uncheck "Build Automatically"
 
-    Import all of the git cloned project folders **EXCEPT** for the main (first) **github.com/Unidata/awips2.git** directory (which should be **~/awips2**).  
+### Importing Git Repos
-    Select **awips2-core**, **awips2-core-foss**, **awips2-foss**, **awips2-ncep**, etc. > Select All Projects > Finish 
 
-    You'll want to import **~/awips2** in two parts to ensure a clean and error-free Eclipse build:
+All of the git repos that were [cloned in the previous step](#4-download-the-source-code) will need to be imported into Eclipse.  **But, be aware the `awips2` repo is done last,** because it requires different steps.
 
-    1. Import **awips2/cave** > Select All Projects > Finish
+1. File > Import > Git > Projects from Git > **Next**
-    2. Import **awips2/edexOsgi** > Select All Projects > Finish
+  ![git import](../images/gitImport1.png)
   
-* Project > Clean
+1. Continue with the default selection, Existing local repository > **Add..** > add each of the git repos (for example `.../awips2-core`) > check the checkbox > **Finish**
+  ![add git repo](../images/gitImport2.png)
   
-    Clean the build and ensure no errors are reported.  
+1. Then for each of the repos (except awips2 right now):
+Select the repo name > **Next** > Continue with default selection (Working Tree) > **Next** > Continue with default selections (all choices selected) > **Finish**
+  ![finish import](../images/gitImport3.png)
   
-* Turn automatic building back on
+1. Finally, for `awips2` repo, follow all the above steps except in the Working Tree, only select:
+    * *cave* > **Next** > **Finish**
+      ![importCave](../images/gitImportCave.png)
+    * *edexOsgi* > **Next** > **Finish**
+      ![importEdexOsgi](../images/gitImportEdexOsgi.png)
 
-    Project > Check "Build Automatically"
+### Final Setup
+
+1. Project > Clean > **OK**
+     * Use default selections: *Clean all projects*, *Start a build immediately*, *Build the entire workspace*
+     * Clean the build and ensure no errors are reported.  
+      ![cleanEclipse](../images/cleanEclipse.png)
+    
+1. Turn automatic building back on
+      * Project > Check "Build Automatically"
     
 ---
 
 ## 6. Run CAVE
     
-Launch CAVE from eclipse using **com.raytheon.viz.product.awips/developer.product**.
+!!! note "CAVE can be ran from eclipse by using the *com.raytheon.viz.product.awips/developer.product*"
 
-Double-click the **developer.product** file to open the Product View in Eclipse.  Select **Overview** > **Synchronize** and then right-click the file in the left-side package explorer:
+Double-click the **developer.product** file to open the Project Explorer in Eclipse.  Select **Overview** > **Synchronize**
 
-Select **Run As** > **Eclipse Application** to launch CAVE in the development environment. 
+![synchronize developer product](../images/synchronizeDeveloperProduct.png)
 
-Select **Debug** > **Eclipse Application** to launch CAVE in in debug mode. 
+Use the **Project Explorer** on the left-hand side of eclipse to run CAVE as a [Java application](#run-application) or in [Debug mode](#debug-application):
+
+### Run Application
+
+Select **Run As** > **Eclipse Application**
+
+![run application](../images/runApplication.png)
+
+### Debug Application
+
+Select **Debug** > **Eclipse Application**
+ 
+![debug application](../images/debugApplication.png)
 
 ---