path: root/README
diff options
authorJohn Mark Bell <>2009-01-09 01:00:23 +0000
committerJohn Mark Bell <>2009-01-09 01:00:23 +0000
commitd788c1c34be2e6443ef57cbcea8f1f2999ca681e (patch)
tree44552b02a68d92400cd2fc111fbb90eeef0ac382 /README
parente3eebbc094cbb85923159e61e47fb0d270eee7fa (diff)
Document the docs target
svn path=/trunk/libparserutils/; revision=6006
Diffstat (limited to 'README')
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 2bb0d75..e0049ac 100644
--- a/README
+++ b/README
@@ -16,6 +16,7 @@ Requirements
+ GNU make or compatible
+ Perl (for the testcases)
+ Pkg-config (for the testcases)
+ + doxygen (for the API documentation)
For enhanced charset support, LibParserUtils may also be configured to use
an iconv() implementation, see the "Enabling iconv() support" section, below.
@@ -42,6 +43,12 @@ API documentation
public API may be found in the "include" directory. The testcase sources
may also be of use in working out how to use it.
+ Additionally, you can use doxygen to auto-generate API documentation, thus:
+ $ make docs
+ Then open the build/docs/html/index.html file in a web browser.
Enabling iconv() support