aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 12 insertions, 27 deletions
diff --git a/README b/README
index dd67fb36b..70b429036 100644
--- a/README
+++ b/README
@@ -76,11 +76,14 @@ Build tools for compiling GNUnet from source:
76- gcc or clang 76- gcc or clang
77- autoconf >= 2.69 (building from git) 77- autoconf >= 2.69 (building from git)
78- automake >= 1.11.1 (building from git) 78- automake >= 1.11.1 (building from git)
79- recutils >= 1.0 (building from git)
79- libtool >= 2.2 80- libtool >= 2.2
80- makeinfo >= 4.8 81- makeinfo >= 4.8
81- make[*3] 82- make[*3]
82- pkgconf or pkg-config 83- pkgconf or pkg-config
83- Texinfo >= 5.2 [*1] 84- sphinx
85- sphinx-rtd-theme
86- sphinx-multiversion
84 87
85Direct dependencies of GNUnet: 88Direct dependencies of GNUnet:
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 89~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -89,12 +92,9 @@ Direct dependencies of GNUnet:
89- gettext 92- gettext
90- gnutls >= 3.2.12 (highly recommended a gnutls 93- gnutls >= 3.2.12 (highly recommended a gnutls
91 linked against libunbound) 94 linked against libunbound)
92- curl (ideally built against gnutls) or gnurl: 95- libcurl >= 7.85.0 (ideally built against gnutls)
93 * libgnurl >= 7.35.0 (recommended, available from
94 https://gnunet.org/en/gnurl.html)
95 or
96 * libcurl >= 7.35.0 (alternative to libgnurl)
97- libgcrypt >= 1.6 96- libgcrypt >= 1.6
97- libgmp any (is also an indirect dependency of gcrypt)
98- libunistring >= 0.9.2 98- libunistring >= 0.9.2
99- libidn: 99- libidn:
100 * libidn2 (preferred) 100 * libidn2 (preferred)
@@ -108,7 +108,7 @@ Direct dependencies of GNUnet:
108 X.509 certificate 108 X.509 certificate
109 for gnunet-gns-proxy-setup-ca) 109 for gnunet-gns-proxy-setup-ca)
110- libltdl >= 2.2 (part of GNU libtool) 110- libltdl >= 2.2 (part of GNU libtool)
111- sqlite >= 3.8 (default database, required) 111- sqlite >= 3.35.0 (default database, required)
112- which (contrib/apparmor(?), gnunet-bugreport, 112- which (contrib/apparmor(?), gnunet-bugreport,
113 and possibly more) 113 and possibly more)
114- zlib 114- zlib
@@ -119,7 +119,6 @@ Direct dependencies of GNUnet:
119Dependencies of optional components/functionality: 119Dependencies of optional components/functionality:
120~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 120~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121- Database plugins (alternatives to sqlite): 121- Database plugins (alternatives to sqlite):
122 * mysql >= 5.1
123 * postgres >= 9.5 122 * postgres >= 9.5
124- Transport plugins: 123- Transport plugins:
125 * bluez (bluetooth transport) 124 * bluez (bluetooth transport)
@@ -137,16 +136,12 @@ Dependencies of optional components/functionality:
137 * TeX Live >= 2012 (for gnunet-bcd[*]) 136 * TeX Live >= 2012 (for gnunet-bcd[*])
138- Documentation: 137- Documentation:
139 * TeX Live >= 2012 (for gnunet-bcd[*]) 138 * TeX Live >= 2012 (for gnunet-bcd[*])
140 * texi2mdoc (for automatic mdoc generation [*2], not 139
141 the texi2mdoc script distributed with
142 autogen but the texi2mdoc C application)
143- Attribute-Based Encryption (experimental):
144 * libpbc >= 0.5.14
145 * libgabe
146- PABC credential support 140- PABC credential support
147 * libpabc any (for re:claimID zero-knowledge privacy 141 * libpabc any (for re:claimID zero-knowledge privacy
148 credentials) 142 credentials)
149 143- re:claimID OpenID Connect plugin
144 * libjose any (for re:claimID OpenID Connect support)
150 145
151 146
152Additional dependencies to run the GNUnet testsuite: 147Additional dependencies to run the GNUnet testsuite:
@@ -181,17 +176,9 @@ Recommended software for developer tools:
181 a limited subset ('texlive-tiny' in Guix) is enough. 176 a limited subset ('texlive-tiny' in Guix) is enough.
182 177
183[*1] The default configuration is to build the info output of the 178[*1] The default configuration is to build the info output of the
184 documentation, and therefore require texinfo. You can pass 179 documentation, and therefore require sphinx. You can pass
185 '--disable-documentation' to the configure script to change this. 180 '--disable-documentation' to the configure script to change this.
186 181
187[*2] If you still prefer to have documentation, you can pass
188 '--enable-texi2mdoc-generation' to build the mdocml ("mandoc")
189 documentation (experimental stages in gnunet).
190 If this proves to be reliable, we will
191 include the mdocml output in the release tarballs.
192 Contrary to the name, texi2mdoc does not require Texinfo,
193 It is a standalone ISO C utility.
194
195[*3] GNU make introduced the != operator in version 4.0. 182[*3] GNU make introduced the != operator in version 4.0.
196 GNU make was released in october 2013, reasonable to 183 GNU make was released in october 2013, reasonable to
197 be widespread by now. If this is not working out for 184 be widespread by now. If this is not working out for
@@ -325,9 +312,7 @@ traversal).
325 312
326GNUnet requires the GNU MP library (https://www.gnu.org/software/gmp/) 313GNUnet requires the GNU MP library (https://www.gnu.org/software/gmp/)
327and libgcrypt (https://www.gnupg.org/). You can specify the path to 314and libgcrypt (https://www.gnupg.org/). You can specify the path to
328libgcrypt by passing "--with-gcrypt=PATH" to configure. You will also 315libgcrypt by passing "--with-gcrypt=PATH" to configure.
329need either sqlite (http://www.sqlite.org/), MySQL
330(http://www.mysql.org/) or PostGres (http://www.postgres.org/).
331 316
332If you install from source, you need to install GNU libextractor first 317If you install from source, you need to install GNU libextractor first
333(download from https://www.gnu.org/software/libextractor/). We also 318(download from https://www.gnu.org/software/libextractor/). We also