1 files changed, 93 insertions, 75 deletions

diff --git a/README b/README
index e6ba9c07e..70b429036 100644
--- a/README
+++ b/README
@@ -5,11 +5,13 @@ ToC
 
 * ToC
 * What is GNUnet?
+* Joining GNU
 * Dependencies
-  o direct dependencies
-  o test suite dependencies
-  o optional dependencies
-  o autotools
+  o Build tools
+  o Dependencies of GNUnet
+  o Dependencies of optional components/functionality
+  o Test suite dependencies
+  o Recommended developer tools
 * Notes on setuid
 * Scope of Operating System support
 * How to install
@@ -23,6 +25,7 @@ ToC
 * Further Reading
 * Stay tuned
 
+
 What is GNUnet?
 ===============
 
@@ -49,6 +52,17 @@ Online documentation is provided at
 'https://docs.gnunet.org' and 'https://tutorial.gnunet.org'.
 
 
+Joining GNU
+===========
+
+This is a GNU program, developed by the GNU Project and part of the
+GNU Operating System. If you are the author of an awesome program and
+want to join us in writing Free Software, please consider making it an
+official GNU program and become a GNU maintainer.  You can find
+instructions on how to do so at http://www.gnu.org/help/evaluation.
+We are looking forward to hacking with you!
+
+
 Dependencies:
 =============
 
@@ -56,50 +70,82 @@ The dependencies for building GNUnet will require around 0.74 GiB
 diskspace. GNUnet itself will require 8 - 9.2 MiB depending on
 configuration.
 
-These are the direct dependencies for running GNUnet:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Build tools for compiling GNUnet from source:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- gcc or clang
+- autoconf           >= 2.69        (building from git)
+- automake           >= 1.11.1      (building from git)
+- recutils           >= 1.0         (building from git)
+- libtool            >= 2.2
+- makeinfo           >= 4.8
+- make[*3]
+- pkgconf or pkg-config
+- sphinx
+- sphinx-rtd-theme
+- sphinx-multiversion
+
+Direct dependencies of GNUnet:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Bash                              (for some scripts)
 - gettext
 - gnutls             >= 3.2.12      (highly recommended a gnutls
                                      linked against libunbound)
-- curl (ideally built against gnutls) or gnurl:
-  * libgnurl         >= 7.35.0      (recommended, available from
-                                     https://gnunet.org/en/gnurl.html)
-  or
-  * libcurl          >= 7.35.0      (alternative to libgnurl)
+- libcurl            >= 7.85.0      (ideally built against gnutls)
 - libgcrypt          >= 1.6
+- libgmp             any            (is also an indirect dependency of gcrypt)
 - libunistring       >= 0.9.2
 - libidn:
-  * libidn2 (prefered)
+  * libidn2 (preferred)
   or
   * libidn           >= 1.0
 - libmicrohttpd      >= 0.9.63
 - libjansson
-- makeinfo           >= 4.8
-- make[*3]
 - nss                               (certutil binary, for
                                      gnunet-gns-proxy-setup-ca)
 - openssl            >= 1.0         (binary, used to generate
                                      X.509 certificate
                                      for gnunet-gns-proxy-setup-ca)
-- pkgconf or pkg-config
-- A Posix shell                       (for some scripts)
-- Texinfo            >= 5.2         [*1]
 - libltdl            >= 2.2         (part of GNU libtool)
-- 1 or more databases:
-  * sqlite           >= 3.8         (default database, required)
-  and/or
-  * mysql            >= 5.1         (alternative to sqlite)
-  and/or
-  * postgres         >= 9.5         (alternative to sqlite)
+- sqlite             >= 3.35.0      (default database, required)
 - which                             (contrib/apparmor(?), gnunet-bugreport,
                                      and possibly more)
 - zlib
 - libsodium          >= 1.0.17      (for elliptic curve cryptography)
+- certtool (gnutls or openssl)      (certtool binary (for convenient
+                                     installation of GNS proxy))
 
-These are the dependencies for GNUnet's testsuite:
+Dependencies of optional components/functionality:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- Database plugins (alternatives to sqlite):
+  * postgres         >= 9.5
+- Transport plugins:
+  * bluez (bluetooth transport)
+- Conversation service:
+  * libopus            >= 1.0.1
+  * libpulse           >= 2.0
+  * libogg             >= 1.3.0
+- File-sharing metadata (highly recommended[*5]):
+  * libextractor       >= 0.6.1
+- NAT uPnP support:
+  * miniupnpc
+- gnunet-qr (Read/write GNUnet URIs from/to QR codes):
+  * libzbar            >= 0.10
+- gnunet-bcd (GNS business card generator):
+  * TeX Live           >= 2012        (for gnunet-bcd[*])
+- Documentation:
+  * TeX Live           >= 2012        (for gnunet-bcd[*])
+
+- PABC credential support
+  * libpabc            any            (for re:claimID zero-knowledge privacy
+                                      credentials)
+- re:claimID OpenID Connect plugin
+  * libjose            any            (for re:claimID OpenID Connect support)
+
+
+Additional dependencies to run the GNUnet testsuite:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Bash                              (for some tests[*4])
 - A Posix Shell                     (for some tests)
@@ -114,65 +160,32 @@ These are the dependencies for GNUnet's testsuite:
     - which
 
 
-These are the optional dependencies:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Recommended software for developer tools:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - awk                               (for linting tests)
 - Bash                              (for Docker and Vagrant)
-- bluez                             (for bluetooth support)
 - grof                              (for linting of man pages)
-- libextractor       >= 0.6.1       (highly recommended[*5])
-- libopus            >= 1.0.1       (for conversation tool)
-- libpulse           >= 2.0         (for conversation tool)
-- libogg             >= 1.3.0       (for conversation tool)
-- libnss                            (certtool binary (for convenient
-                                     installation of GNS proxy))
-- libzbar            >= 0.10        (for gnunet-qr)
-- libpbc             >= 0.5.14      (for Attribute-Based Encryption and
-                                     Identity Provider functionality)
-- libgabe                           (for Attribute-Based Encryption and
-                                     Identity Provider functionality, from
-                                     https://github.com/schanzen/libgabe)
 - mandoc                            (for linting of man pages, generation of
                                      html output of man pages (not part of
                                      the regular build))
-- miniupnpc
 - perl5                             (for some utilities)
-- TeX Live           >= 2012        (for gnunet-bcd[*])
-- texi2mdoc                         (for automatic mdoc generation [*2], not
-                                     the texi2mdoc script distributed with
-                                     autogen but the texi2mdoc C application)
-
-Recommended autotools for compiling the Git version are:
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- autoconf           >= 2.59
-- automake           >= 1.11.1
-- libtool            >= 2.2
 
 
 [*] Mandatory for compiling the info output of the documentation,
     a limited subset ('texlive-tiny' in Guix) is enough.
 
 [*1] The default configuration is to build the info output of the
-     documentation, and therefore require texinfo.  You can pass
+     documentation, and therefore require sphinx.  You can pass
      '--disable-documentation' to the configure script to change this.
 
-[*2] If you still prefer to have documentation, you can pass
-     '--enable-texi2mdoc-generation' to build the mdocml ("mandoc")
-     documentation (experimental stages in gnunet).
-     If this proves to be reliable, we will
-     include the mdocml output in the release tarballs.
-     Contrary to the name, texi2mdoc does not require Texinfo,
-     It is a standalone ISO C utility.
-
 [*3] GNU make introduced the != operator in version 4.0.
      GNU make was released in october 2013, reasonable to
      be widespread by now. If this is not working out for
      you, open a bug so that we can get a more portable
      fix in.
 
-[*4] We are commited  to portable tools and solutions
+[*4] We are committed  to portable tools and solutions
      where possible. New scripts should be Posix sh
      compatible, current and older scripts are
      in the process of being rewritten to comply
@@ -203,7 +216,7 @@ For a correct functionality depending on the host OS, you need
 to run the equivalent of these steps after installation.
 Replace $(DESTDIR)$(libexecdir) with the appropriate paths,
 for example /usr/local/lib/gnunet/libexec/. Note that this
-obviously must be run as priviledged user.
+obviously must be run as privileged user.
 
 chown root:root $(DESTDIR)$(libexecdir)/gnunet-helper-vpn
 chmod u+s $(DESTDIR)$(libexecdir)/gnunet-helper-vpn
@@ -214,9 +227,9 @@ chmod u+s $(DESTDIR)$(libexecdir)/gnunet-helper-transport-bluetooth
 chown root $(DESTDIR)$(libexecdir)/gnunet-helper-dns
 chgrp $(GNUNETDNS_GROUP) $(DESTDIR)$(libexecdir)/gnunet-helper-dns
 chmod 4750 $(DESTDIR)$(libexecdir)/gnunet-helper-dns
-chgrp $(GNUNETDNS_GROUP) $(DESTDIR)$(libexecdir)/gnunet-helper-dns
-chown gnunet:$(GNUNETDNS_GROUP) $(DESTDIR)$(libexecdir)/gnunet-helper-dns
-chmod 2750 $(DESTDIR)$(libexecdir)/gnunet-helper-dns
+chgrp $(GNUNETDNS_GROUP) $(DESTDIR)$(libexecdir)/gnunet-service-dns
+chown gnunet:$(GNUNETDNS_GROUP) $(DESTDIR)$(libexecdir)/gnunet-service-dns
+chmod 2750 $(DESTDIR)$(libexecdir)/gnunet-service-dns
 chown root:root $(DESTDIR)$(libexecdir)/gnunet-helper-exit
 chmod u+s $(DESTDIR)$(libexecdir)/gnunet-helper-exit
 chown root:root $(DESTDIR)$(libexecdir)/gnunet-helper-nat-server
@@ -279,8 +292,8 @@ Building GNUnet from source
 
 IMPORTANT: You can read further notes about compilation from source in
 the handbook under doc/handbook/, which includes notes about specific
-requirements for operating systems aswell. If you are a package
-mantainer for an Operating System we invite you to add your notes if
+requirements for operating systems as well. If you are a package
+maintainer for an Operating System we invite you to add your notes if
 you feel it is necessary and can not be covered in your Operating
 System's documentation.
 
@@ -299,9 +312,7 @@ traversal).
 
 GNUnet requires the GNU MP library (https://www.gnu.org/software/gmp/)
 and libgcrypt (https://www.gnupg.org/).  You can specify the path to
-libgcrypt by passing "--with-gcrypt=PATH" to configure.  You will also
-need either sqlite (http://www.sqlite.org/), MySQL
-(http://www.mysql.org/) or PostGres (http://www.postgres.org/).
+libgcrypt by passing "--with-gcrypt=PATH" to configure.
 
 If you install from source, you need to install GNU libextractor first
 (download from https://www.gnu.org/software/libextractor/).  We also
@@ -328,7 +339,7 @@ in 'contrib/services' or by running:
 
 
 Note that you must read paragraph "Notes on setuid", which documents steps you
-have to follow after the installation, as a priviledged user. We require some
+have to follow after the installation, as a privileged user. We require some
 binaries to be setuid. The most portable approach across all supported
 platforms and targets is to let this be handled manually.
 The installation will work if you do not run these steps as root, but some
@@ -366,7 +377,7 @@ $GNUNET_PREFIX you might have specified, as those libraries must be in
 your packaging script to miss those plugins, so you might need to do some
 additional manual work to include those libraries in your binary package(s).
 Similarly, if you want to use the GNUnet Name System and did NOT run
-GNUnet's 'make install' process with priviledged rights, the libraries will be
+GNUnet's 'make install' process with privileged rights, the libraries will be
 installed to "$GNUNET_PREFIX" and you will have to move them to "/lib/"
 manually.
 
@@ -433,7 +444,7 @@ GNUnet by periodically executing
 $ cat $SERVICEHOME/data/hosts/* > the_file
 
 and offering 'the_file' via your web server.  Alternatively, you can
-run the build-in web server by adding '-p' to the OPTIONS value
+run the built-in web server by adding '-p' to the OPTIONS value
 in the "hostlist" section of gnunet.conf and opening the respective
 HTTPPORT to the public.
 
@@ -485,7 +496,7 @@ https://bugs.gnunet.org/ or our bugs mailinglist.
 Please make sure to run the script "contrib/scripts/gnunet-bugreport"
 and include the output with your bug reports.  More about how to
 report bugs can be found in the GNUnet FAQ on the webpage.  Submit
-patches via E-Mail to gnunet-developers@gnu.org, formated with
+patches via E-Mail to gnunet-developers@gnu.org, formatted with
 `git format-patch`.
 
 In order to run the unit tests by hand (instead of using "make check"),
@@ -530,7 +541,7 @@ Then set in the HTTP section of gnunet.conf the "ADVERTISED_PORT" to
 "ADVERTISED_PORT" to "443" and "PORT" to 4433.
 
 You can do the same trick for the TCP and UDP transports if you want
-to map them to a priviledged port (from the point of view of the
+to map them to a privileged port (from the point of view of the
 network).  However, we are not aware of this providing any advantages
 at this point.
 
@@ -570,6 +581,13 @@ Further Reading
   * Using the webbrowser:
     https://bib.gnunet.org/
 
+Notes on Packaging
+==================
+
+* GNUnet installs binaries which should not be called by the user into
+  $PREFIX/lib/gnunet/libexec. This folder must not be confused with the
+  $PREFIX/libexec. GNUnet does not install anything into the libexec dir
+  to compliant with https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html
 
 Stay tuned
 ==========