aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMartin Schanzenbach <schanzen@gnunet.org>2022-08-02 17:25:41 +0200
committerMartin Schanzenbach <schanzen@gnunet.org>2022-08-02 17:25:41 +0200
commit4fe567d9d94b9159254a2f2cce64855a794d9699 (patch)
treeb286f5a454472ec92ff88376b297e411e64c5843 /README
parente8b7707f833739851227d4865e6c6064865f19ec (diff)
downloadgnunet-4fe567d9d94b9159254a2f2cce64855a794d9699.tar.gz
gnunet-4fe567d9d94b9159254a2f2cce64855a794d9699.zip
DOC: Move from texinfo to sphinx
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 3 insertions, 13 deletions
diff --git a/README b/README
index 5b3a5ccf5..1280f66a7 100644
--- a/README
+++ b/README
@@ -81,7 +81,7 @@ Build tools for compiling GNUnet from source:
81- makeinfo >= 4.8 81- makeinfo >= 4.8
82- make[*3] 82- make[*3]
83- pkgconf or pkg-config 83- pkgconf or pkg-config
84- Texinfo >= 5.2 [*1] 84- sphinx
85 85
86Direct dependencies of GNUnet: 86Direct dependencies of GNUnet:
87~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 87~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -138,9 +138,7 @@ Dependencies of optional components/functionality:
138 * TeX Live >= 2012 (for gnunet-bcd[*]) 138 * TeX Live >= 2012 (for gnunet-bcd[*])
139- Documentation: 139- Documentation:
140 * TeX Live >= 2012 (for gnunet-bcd[*]) 140 * TeX Live >= 2012 (for gnunet-bcd[*])
141 * texi2mdoc (for automatic mdoc generation [*2], not 141
142 the texi2mdoc script distributed with
143 autogen but the texi2mdoc C application)
144- PABC credential support 142- PABC credential support
145 * libpabc any (for re:claimID zero-knowledge privacy 143 * libpabc any (for re:claimID zero-knowledge privacy
146 credentials) 144 credentials)
@@ -180,17 +178,9 @@ Recommended software for developer tools:
180 a limited subset ('texlive-tiny' in Guix) is enough. 178 a limited subset ('texlive-tiny' in Guix) is enough.
181 179
182[*1] The default configuration is to build the info output of the 180[*1] The default configuration is to build the info output of the
183 documentation, and therefore require texinfo. You can pass 181 documentation, and therefore require sphinx. You can pass
184 '--disable-documentation' to the configure script to change this. 182 '--disable-documentation' to the configure script to change this.
185 183
186[*2] If you still prefer to have documentation, you can pass
187 '--enable-texi2mdoc-generation' to build the mdocml ("mandoc")
188 documentation (experimental stages in gnunet).
189 If this proves to be reliable, we will
190 include the mdocml output in the release tarballs.
191 Contrary to the name, texi2mdoc does not require Texinfo,
192 It is a standalone ISO C utility.
193
194[*3] GNU make introduced the != operator in version 4.0. 184[*3] GNU make introduced the != operator in version 4.0.
195 GNU make was released in october 2013, reasonable to 185 GNU make was released in october 2013, reasonable to
196 be widespread by now. If this is not working out for 186 be widespread by now. If this is not working out for