doc readme
authorng0 <ng0@infotropique.org>
Sat, 21 Oct 2017 16:07:09 +0000 (16:07 +0000)
committerng0 <ng0@infotropique.org>
Sat, 21 Oct 2017 16:07:09 +0000 (16:07 +0000)
doc/README.txt

index 016d16c1a7dcbc582ec7fb5e4feb82347379e584..d4c19bba618b14215e3ea5892e2940c7a326c5ab 100644 (file)
@@ -17,8 +17,11 @@ To be moved to an appropriate section of "how to write documentation" or
 
 ** with guix
 
-export the environment variable GUIX_PACKAGE_PATH as $GUIX_PACKAGE_PATH:gnunet/contrib/packages/guix/packages
+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
 
@@ -26,7 +29,9 @@ You need to have Texinfo and Texlive in your path.
 sh bootstrap
 ./configure --enable-documentation
 cd doc
-make doc-all-give-me-the-noise
+make (format you want)
+
+for example: make html, make info, make pdf
 
 * structure (relations)
 
@@ -35,6 +40,7 @@ make doc-all-give-me-the-noise
  -> chapters/installation.texi
  -> chapters/philosophy.texi
  -> chapters/user.texi
+ -> chapters/vocabulary.texi
  -> images/*
  -> gpl-3.0.texi
  -> fdl-1.3.texi
@@ -50,3 +56,9 @@ make doc-all-give-me-the-noise
 - 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"