diff options
Diffstat (limited to 'doc/README.txt')
-rw-r--r-- | doc/README.txt | 42 |
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 @@ | |||
1 | * What's left to do | ||
2 | |||
3 | - Which Texlive modules are needed? Decrease the size. | ||
4 | - Update the content of gnunet documentation. | ||
5 | |||
6 | * How to use (hack) on this | ||
7 | |||
8 | ** with guix | ||
9 | |||
10 | export the environment variable GUIX_PACKAGE_PATH as $GUIX_PACKAGE_PATH:gnunet/contrib/packages/guix/packages | ||
11 | guix environment gnunet-doc | ||
12 | |||
13 | ** without guix | ||
14 | |||
15 | You need to have Texinfo and Texlive in your path. | ||
16 | sh bootstrap | ||
17 | ./configure | ||
18 | cd doc | ||
19 | make doc-all-give-me-the-noise | ||
20 | |||
21 | * structure (relations) | ||
22 | |||
23 | ** gnunet.texi | ||
24 | -> chapters/developer.texi | ||
25 | -> chapters/installation.texi | ||
26 | -> chapters/philosophy.texi | ||
27 | -> chapters/user.texi | ||
28 | -> images/* | ||
29 | -> gpl-3.0.texi | ||
30 | -> fdl-1.3.texi | ||
31 | |||
32 | ** gnunet-c-tutorial.texi | ||
33 | -> figs/Service.pdf | ||
34 | -> figs/System.pdf | ||
35 | -> tutorial-examples/*.c | ||
36 | -> gpl-3.0.texi | ||
37 | -> fdl-1.3.texi | ||
38 | |||
39 | - gnunet-c-tutorial-v1.pdf: original LaTeX "gnunet-c-tutorial.pdf". | ||
40 | - man folder: the man pages. | ||
41 | - doxygen folder | ||
42 | - outdated-and-old-installation-instructions.txt: self described within the file. | ||