# HG changeset patch # User Jamie Bullock # Date 1405611096 -3600 # Node ID 1e76914e890743dee49c806b2c45650fcfcbeb67 # Parent bde5fa8692ff3c45a43dd3bcfcd4e0e472227bb8 Add documentation information to README diff -r bde5fa8692ff -r 1e76914e8907 README.md --- a/README.md Fri Jun 13 17:29:26 2014 +0100 +++ b/README.md Thu Jul 17 16:31:36 2014 +0100 @@ -111,6 +111,20 @@ locate jni.h +## Documentation + +LibXtract headers are documented using [doxygen](http://www.stack.nl/~dimitri/doxygen/) comments. + +If you have doxygen installed, the LibXtract build system should automatically detect this during `configure` and generate [LaTeX](http://www.latex-project.org) and HTML documentation in the `doc` directory when LibXtract is built with `make`. + +The generated HTML documentation can then be viewed in a web browser by opening the file `doc/html/index.html`. + +**Pre-generated documentation can be found on the [LibXtract website](http://jamiebullock.github.io/LibXtract/documentation)** + + + + + ## LicenseĀ  Copyright (C) 2012 Jamie Bullock