doc/documentation/README.txt

   1 * Completion Levels:
   2
   3 ** chapters/philosophy: around 100% fixed after initial export.
   4
   5 * What's left to do
   6
   7 - Which Texlive modules are needed? Decrease the size.
   8   - distro specific, or can we set requirements?
   9 - Update the content of gnunet documentation.
  10 - XXX: images are only generated for the html documentation
  11   with gendoc.sh … FIXME!
  12 - XXX: png,dot, and svg images MUST be converted to eps by the
  13   build system. Right now they aren't, as a result: No images.
  14
  15 * How to use (hack) on this
  16
  17 ** with guix
  18
  19 Adjust accordingly, ie read the Guix Documentation:
  20 setenv GUIX_PACKAGE_PATH "gnunet/contrib/packages/guix/packages"
  21 guix environment gnunet-doc
  22 and
  23 guix build -f contrib/packages/guix/gnunet-doc.scm
  24
  25 ** without guix
  26
  27 You need to have Texinfo and Texlive in your path.
  28 sh bootstrap
  29 ./configure --enable-documentation
  30 cd doc
  31 make (format you want)
  32
  33 for example: make html, make info, make pdf
  34
  35 * structure (relations)
  36
  37 ** gnunet.texi
  38  -> chapters/developer.texi
  39  -> chapters/installation.texi
  40  -> chapters/philosophy.texi
  41  -> chapters/user.texi
  42  -> chapters/vocabulary.texi
  43  -> images/*
  44  -> gpl-3.0.texi
  45  -> fdl-1.3.texi
  46
  47 ** gnunet-c-tutorial.texi
  48  -> figs/Service.pdf
  49  -> figs/System.pdf
  50  -> tutorial-examples/*.c
  51  -> gpl-3.0.texi
  52  -> fdl-1.3.texi
  53
  54 - gnunet-c-tutorial-v1.pdf: original LaTeX "gnunet-c-tutorial.pdf".
  55 - man folder: the man pages.
  56 - doxygen folder
  57 - outdated-and-old-installation-instructions.txt: self described within the file.
  58
  59
  60 Use `gendocs', add to the manual/ directory of the web site.
  61
  62   $ cd doc
  63   $ gendocs.sh gnunet "GNUnet 0.10.X Reference Manual"