aboutsummaryrefslogtreecommitdiff
path: root/rpkid.stable/doc/README
diff options
context:
space:
mode:
authorRob Austein <sra@hactrn.net>2009-04-22 13:46:07 +0000
committerRob Austein <sra@hactrn.net>2009-04-22 13:46:07 +0000
commit725bc9130dd16ffffa5277382b23cda6c069ef6c (patch)
tree5af44e18a41443c108fcd22444fedea9c5fcb2a5 /rpkid.stable/doc/README
parent3752b1127d4834b00a93153b96d23a370738c942 (diff)
Branch stable code from before start of the event-driven rewrite.
svn path=/rpkid.stable; revision=2354
Diffstat (limited to 'rpkid.stable/doc/README')
-rw-r--r--rpkid.stable/doc/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/rpkid.stable/doc/README b/rpkid.stable/doc/README
new file mode 100644
index 00000000..815eae1c
--- /dev/null
+++ b/rpkid.stable/doc/README
@@ -0,0 +1,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.