avoid failing hard if 'gnunetcheck' db does not exist
[oweals/gnunet.git] / README
diff --git a/README b/README
index 256a6c69c388e4e57ac4f58fb15a32cb3fb3e86e..4cfba40704a45a3dc497717af72dd29dd3e0556b 100644 (file)
--- a/README
+++ b/README
@@ -23,6 +23,8 @@ fork!
 
 Additional documentation about GNUnet can be found at
 https://gnunet.org/ and in the 'doc/' folder.
+Online documentation is provided at
+'https://docs.gnunet.org' and 'https://tutorial.gnunet.org'.
 
 
 Dependencies:
@@ -32,19 +34,26 @@ These are the direct dependencies for running GNUnet:
 
 - libmicrohttpd      >= 0.9.42
 - libgcrypt          >= 1.6
-- libgnurl           >= 7.35.0      (recommended, available from https://gnunet.org/gnurl)
+- libgnurl           >= 7.35.0      (recommended, available from https://gnunet.org/en/gnurl.html)
 - libcurl            >= 7.35.0      (alternative to libgnurl)
 - libunistring       >= 0.9.2
 - gnutls             >= 3.2.12      (highly recommended a gnutls linked against libunbound)
-- libidn             >= 1.0
+- libidn:
+  - libidn2 (prefered)
+  or
+  - libidn             >= 1.0
 - libextractor       >= 0.6.1       (highly recommended)
-- openssl            >= 1.0         (binary, used to generate X.509 certificate)
+- openssl            >= 1.0         (binary, used to generate X.509 certificate
+                                     for gnunet-gns-proxy-setup-ca)
+- nss                               (certutil binary, for
+                                     gnunet-gns-proxy-setup-ca)
 - libltdl            >= 2.2         (part of GNU libtool)
 - sqlite             >= 3.8         (default database, required)
 - mysql              >= 5.1         (alternative to sqlite)
 - postgres           >= 9.5         (alternative to sqlite)
 - Texinfo            >= 5.2         [*1]
-- which                             (for the bootstrap script)
+- makeinfo           >= 4.8
+- which                             (bootstrap script and some Makefiles)
 - gettext
 - zlib
 - pkg-config
@@ -53,8 +62,8 @@ These are the direct dependencies for running GNUnet:
 These are the dependencies for GNUnet's testsuite:
 
 - Bash                              (optional (?), for some tests)
-- python             >= 2.7         (optional, only python 2.7 is supported)
-- python-future      >= 2.7         (optional, only python 2.7 is supported)
+- python             >= 3.7         (optional, only python 3.7 is supported)
+- python-future      >= 3.7         (optional, only python 3.7 is supported)
 
 
 These are the optional dependencies:
@@ -63,42 +72,21 @@ These are the optional dependencies:
 - libpulse           >= 2.0         (optional, for experimental conversation tool)
 - libogg             >= 1.3.0       (optional, for experimental conversation tool)
 - libnss                            (optional, certtool binary (for convenient installation of GNS proxy))
-- python-future                     (optional, for some testcases and utilities)
+- python2.7-future                  (optional, for gnunet-qr)
 - python-zbar        >= 0.10        (optional, for gnunet-qr)
 - TeX Live           >= 2012        (optional, for gnunet-bcd[*])
+- texi2mdoc                         (optional, for automatic mdoc generation [*2])
 - libglpk            >= 4.45        (optional, for experimental code)
 - perl5                             (optional, for some utilities)
-- python             >= 2.7         (optional, for gnunet-qr, only python 2.7 is supported)
+- guile              1.6.4          (or later up to 1.8?, optional for gnunet-download-manager)
+- python2.7          >= 2.7         (optional, for gnunet-qr, only python 2.7 is supported)
 - bluez                             (optional, for bluetooth support)
 - miniupnpc
 - libpbc             >= 0.5.14      (optional, for Attribute-Based Encryption and Identity Provider functionality)
 - libgabe                           (optional, for Attribute-Based Encryption and Identity Provider functionality,
                                     from https://github.com/schanzen/libgabe)
 
-=======
-These are the direct dependencies for running GNUnet:
-
-- libmicrohttpd >= 0.9.52
-- libgcrypt     >= 1.6
-- libgnurl      >= 7.35.0 (available from https://gnunet.org/gnurl)
-- libunistring  >= 0.9.2
-- gnutls        >= 3.2.12
-- libidn        >= 1.0
-- libextractor  >= 0.6.1 (highly recommended)
-- openssl       >= 1.0 (binary, used to generate X.509 certificate)
-- libltdl       >= 2.2 (part of GNU libtool)
-- sqlite        >= 3.8 (default database, required)
-- mysql         >= 5.1 (alternative to sqlite)
-- postgres      >= 9.5 (alternative to sqlite)
-- libopus       >= 1.0.1 (optional for experimental conversation tool)
-- libpulse      >= 2.0 (optional for experimental conversation tool)
-- libogg        >= 1.3.0 (optional for experimental conversation tool)
-- python-zbar   >= 0.10 (optional for gnunet-qr)
-- TeX Live      >= 2012 (optional for gnunet-bcd[*])
-- Texinfo       >= 5.2 [*1]
-- libglpk       >= 4.45 (optional for experimental code)
-
-Recommended autotools for compiling the git version are:
+Recommended autotools for compiling the Git version are:
 
 - autoconf           >= 2.59
 - automake           >= 1.11.1
@@ -112,6 +100,13 @@ Recommended autotools for compiling the git version are:
      documentation, and therefore require texinfo.  You can pass
      '--disable-documentation' to the configure script to change this.
 
+[*2] If you still prefer to have documentation, you can pass
+     '--with-section7' to build mdoc documentation (experimental
+     stages in gnunet). If this proves to be reliable, we will
+     include the mdoc output in the release tarballs.
+     Contrary to the name, texi2mdoc does not require texinfo,
+     It is a standalone ISO C utility.
+
 Requirements
 ============
 
@@ -171,22 +166,12 @@ Building GNUnet from source
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 IMPORTANT: You can read further notes about compilation from source in
-the 'doc/FILENAME' document, which includes notes about specific
+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
 you feel it is necessary and can not be covered in your Operating
 System's documentation.
 
-If you are building GNUnet from source you are either interested
-in furthering its development (we have further notes for developer
-builds in our 'GNUnet Developer Handbook') or you don't trust other
-people's binaries or your Operating System doesn't provide any
-binary package (at the moment).
-
-If you're on Gentoo you can build GNUnet using the recipes provided
-in the 'youbroketheinternet' overlay. Other Operating Systems may
-unintentionally require you to build GNUnet from source.
-
 Two prominent examples which currently lack cross-compilation
 support in GNUnet (and native binaries) are MS Windows and Apple macOS.
 For macOS we recommend you to do the build process via Homebrew and a
@@ -210,7 +195,7 @@ If you install from source, you need to install GNU libextractor first
 (download from https://www.gnu.org/software/libextractor/).  We also
 recommend installing GNU libmicrohttpd (download from
 https://www.gnu.org/software/libmicrohttpd/). Furthermore we recommend
-libgnurl (from https://gnunet.org/gnurl).
+libgnurl (from https://gnunet.org/en/gnurl.html).
 Then you can start the actual GNUnet compilation process with:
 
 
@@ -322,7 +307,7 @@ Usage
 =====
 
 For detailed usage notes, instructions and examples, refer to the
-included 'GNUnet User Handbook'.
+included 'GNUnet Handbook'.
 
 First, you must obtain an initial list of GNUnet hosts.  Knowing a
 single peer is sufficient since after that GNUnet propagates
@@ -383,7 +368,7 @@ Hacking GNUnet
 ==============
 
 Contributions are welcome. Please submit bugs you find to
-https://gnunet.org/bugs/.
+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
@@ -403,7 +388,7 @@ $ make install
 $ export $GNUNET_PREFIX=$SOMEWHERE
 $ make check
 
-Some of the testcases require python >= 2.7, and the python modules
+Some of the testcases require python >= 3.7, and the python modules
 "python-future" (http://python-future.org/) and "pexpect" to be installed.
 If any testcases fail to pass on your system, run
 "contrib/scripts/gnunet-bugreport" (in the repository) or "gnunet-bugreport"
@@ -468,9 +453,9 @@ Further Reading
   There are currently 2 ways to get them:
 
   * Using git:
-    git clone https://gnunet.org/git/bibliography.git
+    git clone https://git.gnunet.org/bibliography.git
   * Using Drupal:
-    https://gnunet.org/bibliography
+    https://old.gnunet.org/bibliography
 
   The Drupal access will be replaced by a new interface to our
   bibliography in 2019.
@@ -480,8 +465,8 @@ Stay tuned
 ==========
 
 * https://gnunet.org/
-* https://gnunet.org/bugs/
-* https://gnunet.org/git/
+* https://bugs.gnunet.org
+* https://git.gnunet.org
 * http://www.gnu.org/software/gnunet/
 * http://mail.gnu.org/mailman/listinfo/gnunet-developers
 * http://mail.gnu.org/mailman/listinfo/help-gnunet