aboutsummaryrefslogtreecommitdiff
path: root/rpkid/doc/README
blob: 815eae1cbe03e9cf816ec9a1df1562ec75d122a9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
$Id$

Documentation for rpkid and friends.

Other than this file, everything in this directory is automatically
generated from the source code.  Most of the hand-written
documentation for rpkid and friends is written using Doxygen markup so
that it will all appear in the manual.

The primary tool for generating documentation is Doxygen, which
produces the HTML and PDF versions of the manual.  Certain pages are
also dumped from HTML to flat text.

See rpkid/Makefile for details on how all this happens.