cannam@124: GNU/Linux:
cannam@124: ----------
cannam@124: 
cannam@124: 1) Download and install a recent version of Doxygen (preferably version 1.3.3 or 
cannam@124: later). See http://www.doxygen.org/.
cannam@124: 2) Download and install a recent version of GraphViz. See 
cannam@124: http://www.research.att.com/sw/tools/graphviz/.
cannam@124: 3) Run ``doxygen config.doxy.linux'' in this directory or load and generate the file 
cannam@124: config.doxy.linux from the Doxywizard application. Or alternatively ``make docs'' can 
cannam@124: be run from the build/gnu folder.
cannam@124: 
cannam@124: The generated html documentation will be placed in /doc/api_reference/. To open 
cannam@124: the main page of the documentation, open the file /doc/api_reference/index.html in 
cannam@124: an html browser.
cannam@124: 
cannam@124: 
cannam@124: Windows:
cannam@124: --------
cannam@124: 
cannam@124: 1) Download and install a recent Doxygen (preferably version 1.3.4 or later). See 
cannam@124: http://www.doxygen.org/.
cannam@124: 2) Download and install a recent version of GraphViz. See 
cannam@124: http://www.research.att.com/sw/tools/graphviz/.
cannam@124: 3) If needed, edit the config.doxy file in an ascii text editor so that 
cannam@124: ``DOT_PATH'' variable points to the folder where GraphViz is installed.
cannam@124: 4) Run ``doxygen config.doxy'' in this directory or load and generate the file 
cannam@124: config.doxy from the Doxywizard application.
cannam@124: 
cannam@124: The generated html documentation will be placed in /doc/api_reference/. To open 
cannam@124: the main page of the documentation, open the file /doc/api_reference/index.html in 
cannam@124: an html browser.
cannam@124: 
cannam@124: 
cannam@124: