summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 11 insertions, 0 deletions
diff --git a/README b/README
index 317a2c6..4a2ccab 100644
--- a/README
+++ b/README
@@ -18,6 +18,17 @@ on top of this library.
is reduced, i.e. the library provides many helpers, but the programmer is not
forced to use them.
+= Documentation =
+
+If doxygen is installed on your system, you can enable it via:
+
+ ./configure --with-doxygen=yes
+
+then type `make`.
+
+To access the doxygen documentation, open the doxygen/html/index.html file with
+a web browser.
+
= Example files =
You can find several example files under examples/ that you can compile by