docs/README

   1 docs
   2 ----
   3  As of FileManager-Actions 3.4, the documentation is composed of two
   4  main parts:
   5
   6  - the Reference Manual describes all features of the product, rather
   7    targeting developers and packagers;
   8
   9  - the FileManager-Actions Configuration Tool User's Manual.
  10
  11  All the documentation, whether it targets users or developers, is made
  12  of architecture-independent files, and so default to be included in the
  13  distributed tarball.
  14
  15 Build system rationale
  16 ----------------------
  17  As all the documentation is distributed, the following rules apply:
  18
  19  - default options do not build the documentation
  20
  21  - because the packager is able to install the documentation from the
  22    distributed tarball, it is enough if only the maintainer is able to
  23    build this documentation
  24
  25  - as a consequence, while the source build system must stay compatible
  26    with the oldest targeted distribution, the documentation build system
  27    may be more recent, as it will only be run on the maintainer
  28    development machine
  29
  30 -----------------------------------------------------------------------
  31  P. Wieser, last updated on feb. 2017