From fb4a583fda06b0ba8a1cfd792982d929a6f45855 Mon Sep 17 00:00:00 2001 From: Jamie Bullock Date: Thu, 17 Jul 2014 16:31:36 +0100 Subject: Add documentation information to README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 90f815f..19be5ad 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,20 @@ To find out where your headers are: 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 -- cgit v1.2.3