-----------------------------------------------------------------
----------  BerkeleyGW, Doxygen Documentation -------------------
-----------------------------------------------------------------

Description
-----------

 This directory automatically generates documentation for BerkeleyGW 
using Doxygen. This is aimed towards developers, and end-users might
as well just ignore this directory.

 To create the documentation, simply type `make`. You`ll need doxygen and
graphviz installed. Then open doxygen/html/index.html in a web browser.


Obtaining Doxygen and Graphviz
------------------------------ 

 Doxygen and graphviz are available at:

 http://www.doxygen.org/
 http://www.graphviz.org/

 Alternatively, if you have a Debian-based distribution, such as
Ubuntu, you can ask your administrator to install the following packages:

 apt-get install doxygen graphviz

or on MacOS with MacPorts (www.macports.org):

 port install doxygen graphviz
