doc/documentation/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    - Expection by texi2pdf output so far: URLs will break
  10      (inserted whitespace) when they contain linebreaks
  11      within the @url{} / @uref{}.
  12
  13 3. Do not use tab characters (see chapter 2.1 texinfo manual)
  14 * What's left to do
  15
  16 - Which Texlive modules are needed? Decrease the size.
  17 - Update the content of gnunet documentation.
  18
  19 * How to use (hack) on this
  20
  21 ** with guix
  22
  23 Adjust accordingly, ie read the Guix Documentation:
  24 setenv GUIX_PACKAGE_PATH "gnunet/contrib/packages/guix/packages"
  25 guix environment gnunet-doc
  26 and
  27 guix build -f contrib/packages/guix/gnunet-doc.scm
  28
  29 ** without guix
  30
  31 You need to have Texinfo and Texlive in your path.
  32 sh bootstrap
  33 ./configure --enable-documentation
  34 cd doc
  35 make (format you want)
  36
  37 for example: make html, make info, make pdf
  38
  39 * structure (relations)
  40
  41 ** gnunet.texi
  42  -> chapters/developer.texi
  43  -> chapters/installation.texi
  44  -> chapters/philosophy.texi
  45  -> chapters/user.texi
  46  -> chapters/vocabulary.texi
  47  -> images/*
  48  -> gpl-3.0.texi
  49  -> fdl-1.3.texi
  50
  51 ** gnunet-c-tutorial.texi
  52  -> figs/Service.pdf
  53  -> figs/System.pdf
  54  -> tutorial-examples/*.c
  55  -> gpl-3.0.texi
  56  -> fdl-1.3.texi
  57
  58 - gnunet-c-tutorial-v1.pdf: original LaTeX "gnunet-c-tutorial.pdf".
  59 - man folder: the man pages.
  60 - doxygen folder
  61 - outdated-and-old-installation-instructions.txt: self described within the file.
  62
  63
  64 Use `gendocs', add to the manual/ directory of the web site.
  65
  66   $ cd doc
  67   $ gendocs.sh gnunet "GNUnet 0.10.X Reference Manual"