doc/src/library/README

   1
   2 This directory contains the main RMR library documentation
   3 such as the user guide and any internal doc; all of which will
   4 likely share a common set of figures, glossary, and index
   5 lists.  The "main" for each doc is the single .xfm file and
   6 all modules are contained in .im files to allow sharing between
   7 documents as makes sense (e.g. glossary).
   8
   9 Illustrations are all located in the ./figures directory and
  10 are created as .fig files [1] which describe drawings using an
  11 open ASCII format (rather than as a binary and/or propriatory
  12 descritption). ASCII descriptions are easily maintained as
  13 source code to track changes and revert when necessary.
  14 A Dockerfile in the tools directory can be used to build a
  15 "development image" with all of the tools needed to render
  16 the PNG and encapsulated postscript derivations from the ASCII
  17 descriptions.  Use of this image is not required, but might be
  18 needed if a development environment doesn't provide Xfig and
  19 the related tools.
  20
  21 [1]
  22         Defacto standard tools for creating and managing .fig files:
  23
  24         Install Xfig on a Linux system with:
  25                 apt-get install xfig    (ubuntu-ish)
  26                 zypper install xfig             (OpenSuse)
  27
  28         The fig2dev tool is used to "batch" process .fig files in
  29         order to generate desired output (.eps, .png, etc.). These
  30         can be installed with commands such as:
  31                 apt-get install fig2dev
  32                 zypper install transfig