1 To be moved to an appropriate section of "how to write documentation" or
2 "how to contribute to the documentation":
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
8 2. Keep line length below 74 characters.
10 3. Do not use tab characters (see chapter 2.1 texinfo manual)
13 - Which Texlive modules are needed? Decrease the size.
14 - Update the content of gnunet documentation.
16 * How to use (hack) on this
20 Adjust accordingly, ie read the Guix Documentation:
21 setenv GUIX_PACKAGE_PATH "gnunet/contrib/packages/guix/packages"
22 guix environment gnunet-doc
24 guix build -f contrib/packages/guix/gnunet-doc.scm
28 You need to have Texinfo and Texlive in your path.
30 ./configure --enable-documentation
32 make (format you want)
34 for example: make html, make info, make pdf
36 * structure (relations)
39 -> chapters/developer.texi
40 -> chapters/installation.texi
41 -> chapters/philosophy.texi
43 -> chapters/vocabulary.texi
48 ** gnunet-c-tutorial.texi
51 -> tutorial-examples/*.c
55 - gnunet-c-tutorial-v1.pdf: original LaTeX "gnunet-c-tutorial.pdf".
56 - man folder: the man pages.
58 - outdated-and-old-installation-instructions.txt: self described within the file.
61 Use `gendocs', add to the manual/ directory of the web site.
64 $ gendocs.sh gnunet "GNUnet 0.10.X Reference Manual"