From 7f07f09d52aed7c449a330d8a82c1280776e49e0 Mon Sep 17 00:00:00 2001 From: ng0 Date: Sat, 21 Oct 2017 16:37:12 +0000 Subject: move docmentation to separate folder --- doc/documentation/README.txt | 64 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 doc/documentation/README.txt (limited to 'doc/documentation/README.txt') diff --git a/doc/documentation/README.txt b/doc/documentation/README.txt new file mode 100644 index 000000000..d4c19bba6 --- /dev/null +++ b/doc/documentation/README.txt @@ -0,0 +1,64 @@ +To be moved to an appropriate section of "how to write documentation" or +"how to contribute to the documentation": + +1. When writing documentation, please use gender-neutral wording when + referring to people, such as singular “they”, “their”, “them”, and + so forth. -> https://en.wikipedia.org/wiki/Singular_they + +2. Keep line length below 74 characters. + +3. Do not use tab characters (see chapter 2.1 texinfo manual) +* What's left to do + +- Which Texlive modules are needed? Decrease the size. +- Update the content of gnunet documentation. + +* How to use (hack) on this + +** with guix + +Adjust accordingly, ie read the Guix Documentation: +setenv GUIX_PACKAGE_PATH "gnunet/contrib/packages/guix/packages" +guix environment gnunet-doc +and +guix build -f contrib/packages/guix/gnunet-doc.scm + +** without guix + +You need to have Texinfo and Texlive in your path. +sh bootstrap +./configure --enable-documentation +cd doc +make (format you want) + +for example: make html, make info, make pdf + +* structure (relations) + +** gnunet.texi + -> chapters/developer.texi + -> chapters/installation.texi + -> chapters/philosophy.texi + -> chapters/user.texi + -> chapters/vocabulary.texi + -> images/* + -> gpl-3.0.texi + -> fdl-1.3.texi + +** gnunet-c-tutorial.texi + -> figs/Service.pdf + -> figs/System.pdf + -> tutorial-examples/*.c + -> gpl-3.0.texi + -> fdl-1.3.texi + +- gnunet-c-tutorial-v1.pdf: original LaTeX "gnunet-c-tutorial.pdf". +- man folder: the man pages. +- doxygen folder +- outdated-and-old-installation-instructions.txt: self described within the file. + + +Use `gendocs', add to the manual/ directory of the web site. + + $ cd doc + $ gendocs.sh gnunet "GNUnet 0.10.X Reference Manual" -- cgit v1.2.3