diff options
Diffstat (limited to 'rpkid')
| -rw-r--r-- | rpkid/README | 2 | ||||
| -rw-r--r-- | rpkid/doc/README | 14 |
2 files changed, 16 insertions, 0 deletions
diff --git a/rpkid/README b/rpkid/README index 7427fec0..f9cdb877 100644 --- a/rpkid/README +++ b/rpkid/README @@ -4,6 +4,8 @@ Python RPKI production tools. Requires Python 2.5. +See doc/Installation for installation instructions. + External Python packages required: - lxml, which in turn requires the libxml2 C libraries. diff --git a/rpkid/doc/README b/rpkid/doc/README new file mode 100644 index 00000000..815eae1c --- /dev/null +++ b/rpkid/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. |