doc/README.txt

   1 To be moved to an appropriate section of "how to write documentation" or
   2 "how to contribute to the documentation":
   3
   4 1. When writing documentation, please use gender-neutral wording when
   5    referring to people, such as singular “they”, “their”, “them”, and
   6    so forth. -> https://en.wikipedia.org/wiki/Singular_they
   7
   8 2. Keep line length below 74 characters.
   9
  10 3. Do not use tab characters (see chapter 2.1 texinfo manual)
  11 * What's left to do
  12
  13 - Which Texlive modules are needed? Decrease the size.
  14 - Update the content of gnunet documentation.
  15
  16 * How to use (hack) on this
  17
  18 ** with guix
  19
  20 Adjust accordingly, ie read the Guix Documentation:
  21 setenv GUIX_PACKAGE_PATH "gnunet/contrib/packages/guix/packages"
  22 guix environment gnunet-doc
  23 and
  24 guix build -f contrib/packages/guix/gnunet-doc.scm
  25
  26 ** without guix
  27
  28 You need to have Texinfo and Texlive in your path.
  29 sh bootstrap
  30 ./configure --enable-documentation
  31 cd doc
  32 make (format you want)
  33
  34 for example: make html, make info, make pdf
  35
  36 * structure (relations)
  37
  38 ** gnunet.texi
  39  -> chapters/developer.texi
  40  -> chapters/installation.texi
  41  -> chapters/philosophy.texi
  42  -> chapters/user.texi
  43  -> chapters/vocabulary.texi
  44  -> images/*
  45  -> gpl-3.0.texi
  46  -> fdl-1.3.texi
  47
  48 ** gnunet-c-tutorial.texi
  49  -> figs/Service.pdf
  50  -> figs/System.pdf
  51  -> tutorial-examples/*.c
  52  -> gpl-3.0.texi
  53  -> fdl-1.3.texi
  54
  55 - gnunet-c-tutorial-v1.pdf: original LaTeX "gnunet-c-tutorial.pdf".
  56 - man folder: the man pages.
  57 - doxygen folder
  58 - outdated-and-old-installation-instructions.txt: self described within the file.
  59
  60
  61 Use `gendocs', add to the manual/ directory of the web site.
  62
  63   $ cd doc
  64   $ gendocs.sh gnunet "GNUnet 0.10.X Reference Manual"