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 /doc | |
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 'doc')
-rw-r--r-- | doc/README | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/README b/doc/README new file mode 100644 index 00000000..84c9d4cc --- /dev/null +++ b/doc/README @@ -0,0 +1,18 @@ +$Id$ + +This directory contains PDF and flat text translations of the +documentation for the RPKI toolkit. The primary documentation source +is the web site http://trac.rpki.net/, the files here are best-effort +attempts at mechanical translation of that content into other formats. + +The doc.* files are flat text translated by html2text. + +manual.pdf is a translation by htmldoc. + +Neither translation is perfect, something is always lost. When in +doubt, consult the web site if you can. + +In theory, the contents of this directory are kept up to date with +respect to the web site by a cron job. If you happen notice that the +contents here seem to be lagging the web site by more than a few +hours, please report it. |