doc/src/README

   1
   2 Directories within this directory contains collections of documents
   3 such as the manual pages and main RMR user guide.   Three are some
   4 imbed files at this level which make setup to generate document
   5 output in different flavours (e.g. postscript and troff) possible.
   6
   7 For the most part, document output is genreated during the build
   8 process and left at the top level build directory.  Manual pages
   9 are the noted exception as the troff output is placed into the
  10 development pacage files and will be installed with the RMR library
  11 (archive) such that the standard UNIX man command will generate
  12 the needed documentation that develoers expect.
  13
  14
  15 Directory overview:
  16         library - Documentation on the RMR libraray itself. User manual
  17                         and internal doc.
  18
  19         binding - Any documentation needed for the language wrappers
  20                         or bindings.
  21
  22         man - Manual page source.
  23
  24         tools - Some useful things that migth make building and/or
  25                         maintaining documents easier.