doc: actually add the README.txt.

1 files changed, 42 insertions, 0 deletions

diff --git a/doc/README.txt b/doc/README.txt
new file mode 100644
index 000000000..2abe479dd
--- /dev/null
+++ b/doc/README.txt
@@ -0,0 +1,42 @@
+* 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
+
+export the environment variable GUIX_PACKAGE_PATH as $GUIX_PACKAGE_PATH:gnunet/contrib/packages/guix/packages
+guix environment gnunet-doc
+
+** without guix
+
+You need to have Texinfo and Texlive in your path.
+sh bootstrap
+./configure
+cd doc
+make doc-all-give-me-the-noise
+
+* structure (relations)
+
+** gnunet.texi
+ -> chapters/developer.texi
+ -> chapters/installation.texi
+ -> chapters/philosophy.texi
+ -> chapters/user.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.