diff options
author | Rob Austein <sra@hactrn.net> | 2012-04-16 20:32:12 +0000 |
---|---|---|
committer | Rob Austein <sra@hactrn.net> | 2012-04-16 20:32:12 +0000 |
commit | 2d26c4f5e632286cf6a75e20229f95fa799f5147 (patch) | |
tree | e9179438e7d39a02ddb655bec818bdcb5a203e77 /rpkid/doc/README | |
parent | 6f45f4a6b5a65ab12db71623877ce075f218e98c (diff) |
Clean up README files. Mostly this means changing them to pointers to
the real consolidated documentation.
Delete old Doxygen-based rpkid manual and stuff that went with it,
while retaining ability to generate Doxygen manual of internals for
the libraries.
This closes #232.
svn path=/trunk/; revision=4424
Diffstat (limited to 'rpkid/doc/README')
-rw-r--r-- | rpkid/doc/README | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/rpkid/doc/README b/rpkid/doc/README index 8430bcf0..33902d7e 100644 --- a/rpkid/doc/README +++ b/rpkid/doc/README @@ -1,17 +1,16 @@ $Id$ -Documentation for rpkid and friends. +Internals documentation for the RPKI CA tools. -Most of the files in this directory are 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. +Once upon a time this included the hand-written documentation for the +CA tools, but that is now part of the overall package documentation. +What's left here is just what Doxygen generates from the source code +and a few Graphviz diagrams. -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. +At the moment the control for the stuff generated here is still +../Makefile, that may change at some point. -See rpkid/Makefile for details on how all this happens. - -The full manual is available in both PDF and HTML formats; the PDF is -in manual.pdf, the HTML is in a compressed tarball manual.tar.gz. +We no longer generate the documentation here automatically, as it's +kind of large and we're not sure anybody else cares about it, so if +you want this manual you'll have to install Doxygen and build it +yourself. |