[Dart-dev] [7259] DART/trunk/doc/doxygen/README: updated with suggestions from kevin, thanks.

[nancy at ucar.edu]

Revision: 7259
Author:   nancy
Date:     2014-11-19 10:57:25 -0700 (Wed, 19 Nov 2014)
Log Message:
-----------
updated with suggestions from kevin, thanks.

Modified Paths:
--------------
    DART/trunk/doc/doxygen/README

-------------- next part --------------
Modified: DART/trunk/doc/doxygen/README
===================================================================
--- DART/trunk/doc/doxygen/README	2014-11-13 22:24:45 UTC (rev 7258)
+++ DART/trunk/doc/doxygen/README	2014-11-19 17:57:25 UTC (rev 7259)
@@ -8,33 +8,41 @@
 
 To create html pages from the DART source:
 
-Copy these 3 files into any model's "work" directory, and run
-'gendocs'.  You must have doxygen installed somewhere on your
-search path.  The 'gendocs' script will generate a single
-index.html page, plus directories of documentation for each
-executable that has an mkmf_xxx and path_names_xxx pair of
-files in the work directory.  All documentation will be
-created and put under $DART/docs/doxygen/model_name.
+- You must have doxygen installed somewhere on your search path.  
+  From a terminal window type 'which doxygen'.  For Linux systems
+  in many cases this is already installed.  For Macs try one of
+  the package managers like 'macports'.  The GUI download .dmg
+  file will install a GUI interface but apparently not the command
+  line version we need.  If 'which doxygen' gives you an error and
+  you believe it is already installed you may need to add the directory
+  where the binary was installed to your PATH environment variable.  
 
+- Copy the 3 files in this directory into any model's 'work' directory,
+  cd into that directory and run the './gendocs' shell script.  It will 
+  generate a single index.html main page plus separate documentation pages 
+  for each executable that has a mkmf_xxx and path_names_xxx pair of files 
+  in the work directory.  All documentation will be created and put under 
+  $DART/doc/doxygen/model_name.
+
 To use the documentation:
 
-Open the $DART/docs/doxygen/model_name/index.html and click
-on any executable name.
+- Open $DART/doc/doxygen/model_name/index.html in a browser and click
+  on any executable name.
 
-Click on the triangle in front of 'Data Types List' to open the list.
+- Click on the triangle in front of 'Data Types List' to open the list.
 
-There is a second 'Data Types List'.  Click on that triangle in
-front of the second 'Data Types List' to open the list. You
-should see a list of modules.
+- There is a second 'Data Types List'.  Click on that triangle in
+  front of the second 'Data Types List' to open the list. You
+  should see a list of modules.
 
-If you click on the text 'Data Types List' instead of the triangle,
-you get a different view of all the modules with the defined data
-types listed.
+- If you click on the text 'Data Types List' instead of the triangle,
+  you get a different view of all the modules with the defined data
+  types listed.
 
-Click on one of the modules.  You will then see the reference page
-for that module, with the public types, functions, subroutines,
-and private types, functions, and subroutines.  
+- Click on one of the modules.  You will then see the reference page
+  for that module, with the public types, functions, subroutines,
+  and private types, functions, and subroutines.  
 
-Any text in blue can be clicked on and it will take you to the
-reference page for that type, function or subroutine.
+- Any text in blue can be clicked on and it will take you to the
+  reference page for that type, function or subroutine.