doc/README

   1
   2 Documentation for RMr.
   3
   4 Most (all?) documentation for RMr is built from source ({X)fm, or other text
   5 formatter source, not the RMr code) rather than hand editing the output
   6 (markdown/rst) files.  This allows for more control over the output, a wider
   7 variety of output types, and (most importantly) the generation of multiple
   8 output from the same source (e.g. man pages can be rendered in troff which
   9 the man command required, and also rendered as .rst or .md files which some
  10 wikis prefer, and as PDF which can be easily distributed).
  11
  12 Thus, there is a source file below this directory which has the document
  13 source.  There may also be an output directory at this level. If necessary,
  14 the output directory will contain generated documents (.rst files?) which for
  15 some odd reason need to also be committed to the repo (I don't commit binaries
  16 so I'm having a difficult time sorting out the reason why these generated files
  17 might be committed).