Mercurial > hg > libxtract

changeset 247:1e76914e8907

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation information to README
author Jamie Bullock <jamie@jamiebullock.com>
date Thu, 17 Jul 2014 16:31:36 +0100
parents bde5fa8692ff
children 4a9a0c872494
files README.md
diffstat 1 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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