fix rps
[oweals/gnunet.git] / README
diff --git a/README b/README
index 0fbffa97ba57024b099379be93697dbf300f0340..7f73525e890912d253be3b901b842d870e3b86df 100644 (file)
--- a/README
+++ b/README
@@ -1,27 +1,19 @@
-======================================================================
-
-THIS SVN VERSION OF GNUNET IS INCOMPATIBLE TO ALL PREVIOUS RELEASES.
-WE ARE WORKING ON CHANGING FUNDAMENTAL PARTS OF THE CRYPTOGRAPHIC
-PARTS OF THE SYSTEM.  
-
-You need to install libgcrypt from git master (1.6.0beta93 at least)
-for the code to compile.
-
-=======================================================================
-
                        Welcome to GNUnet
 
 
 What is GNUnet?
 ===============
 
-GNUnet is peer-to-peer framework focusing on security.  The first and
-primary application for GNUnet is anonymous file-sharing.  GNUnet is
-currently developed by a worldwide group of independent free software
-developers.  GNUnet is a GNU package (http://www.gnu.org/).
+GNUnet is peer-to-peer framework providing a network abstractions and
+applications focusing on security and privacy.  So far, we have
+created applications for anonymous file-sharing, decentralized naming
+and identity management, decentralized and confidential telephony and
+tunneling IP traffic over GNUnet.  GNUnet is currently developed by a
+worldwide group of independent free software developers.  GNUnet is a
+GNU package (http://www.gnu.org/).
 
-This is an ALPHA release.  There are known and significant bugs as 
-well as many missing features in this release.  
+This is an ALPHA release.  There are known and significant bugs as
+well as many missing features in this release.
 
 Additional documentation about GNUnet can be found at
 https://gnunet.org/.
@@ -32,30 +24,36 @@ Dependencies:
 
 Please note that for many of its dependencies GNUnet requires very
 recent versions of the libraries which are often NOT to be found in
-stable distributions in 2011.  While using older packages may in some
+stable distributions in 2014.  While using older packages may in some
 cases on some operating systems may seem to work in some limited
 fashion, we are in many cases aware of serious problems with older
 packages.  Hence please make sure to use  the versions listed below.
 
 These are the direct dependencies for running GNUnet:
 
-- libextractor  >= 0.6.1
-- libmicrohttpd >= 0.9.18
-- libgcrypt     >= 1.2
-- libcurl       >= 7.21.3
+- libmicrohttpd >= 0.9.42
+- libgcrypt     >= 1.6
+- libgnurl      >= 7.35.0 (available from https://gnunet.org/gnurl)
 - libunistring  >= 0.9.2
-- gnutls        >= 2.12.0
+- 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.0 (default database)
-- mysql         >= 5.1 (alternative to sqLite)
-- postgres      >= 8.3 (alternative to sqLite)
+- sqlite        >= 3.8 (default database, required)
+- mysql         >= 5.1 (alternative to sqlite)
+- postgres      >= 9.6 (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)
+- libglpk       >= 4.45 (optional for experimental code)
 
 Recommended autotools for compiling the SVN version are:
 - autoconf >= 2.59
 - automake >= 1.11.1
-- libtool  >= 2.2 
+- libtool  >= 2.2
 
 
 How to install?
@@ -83,10 +81,10 @@ recommend installing GNU libmicrohttpd (download from
 http://www.gnu.org/software/libmicrohttpd/).  Then you can start the
 actual GNUnet compilation and installation process with:
 
-$ export GNUNET_PREFIX=/usr/local # or other directory of your choice
+$ export GNUNET_PREFIX=/usr/local/lib # or other directory of your choice
 # addgroup gnunetdns
-# adduser gnunet gnunet
-# ./configure --prefix=$GNUNET_PREFIX --with-extractor=$LE_PREFIX
+# adduser --system --home "/var/lib/gnunet" --group gnunet --shell /bin/sh
+# ./configure --prefix=$GNUNET_PREFIX/.. --with-extractor=$LE_PREFIX
 $ make
 # make install
 # sudo -u gnunet gnunet-arm -s
@@ -99,11 +97,11 @@ may not be installed in the perfect place or with the right
 permissions and thus won't work.
 
 This will create the users and groups needed for running GNUnet
-securely and then compile and install GNUnet to $GNUNET_PREFIX/bin/,
-$GNUNET_PREFIX/lib/ and $GNUNET_PREFIX/share/ and start the system
+securely and then compile and install GNUnet to $GNUNET_PREFIX/../bin/,
+$GNUNET_PREFIX/ and $GNUNET_PREFIX/../share/ and start the system
 with the default configuration.  It is strongly recommended that you
 add a user "gnunet" to run "gnunet-arm".  You can then still run the
-end-user applications as another user.  
+end-user applications as another user.
 
 If you create a system user "gnunet", it is recommended that you edit
 the configuration file slightly so that data can be stored in the
@@ -112,15 +110,16 @@ the $HOME-directory of your "gnunet" user is, you might need to set
 the SERVICEHOME option in section "[PATHS]" to "/var/lib/gnunet" to
 do this.  Depending on your personal preferences, you may also want to
 use "/etc/gnunet.conf" for the location of the configuration file in
-this case (instead of ~gnunet/.gnunet/gnunet.conf").  In this case,
-you need to start GNUnet using "gnunet-arm -s -c /etc/gnunet.conf".
+this case (instead of ~gnunet/.config/gnunet.conf").  In this case,
+you need to start GNUnet using "gnunet-arm -s -c /etc/gnunet.conf" or
+set "XDG_CONFIG_HOME=/etc/".
 
 You can avoid running 'make install' as root if you run configure
 with the "--with-sudo=yes" option and have extensive sudo rights
 (can run "chmod +s" and "chown" via 'sudo').  If you run 'make install'
 as a normal user without sudo rights (or the configure option),
 certain binaries that require additional priviledges will not be
-installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and 
+installed properly (and autonomous NAT traversal, WLAN, DNS/GNS and
 the VPN will then not work).
 
 If you run 'configure' and 'make install' as root or use the SUDO
@@ -132,7 +131,7 @@ 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 naming system and did NOT run GNUnet's 'make
 install' process with SUDO rights, the libraries will be installed to
-"$GNUNET_PREFIX/lib" and you will have to move them to "/lib/"
+"$GNUNET_PREFIX" and you will have to move them to "/lib/"
 manually.
 
 Finally, if you are compiling the code from subversion, you have to
@@ -167,9 +166,9 @@ about the GNU build process read the INSTALL file.
 
 GNUnet uses two types of configuration files, one that specifies the
 system-wide defaults (typically located in
-$GNUNET_PREFIX/share/gnunet/config.d/) and a second one that overrides
+$GNUNET_PREFIX/../share/gnunet/config.d/) and a second one that overrides
 default values with user-specific preferences.  The user-specific
-configuration file should be located in "~/.gnunet/gnunet.conf" or its
+configuration file should be located in "~/.config/gnunet.conf" or its
 location can be specified by giving the "-c" option to the respective
 GNUnet application.
 
@@ -222,7 +221,7 @@ together with a description.  To publish files on GNUnet, use the
 
 
 The GTK user interface is shipped separately.  After downloading and
-installing gnunet-gtk, you can invoke the setup tool and the 
+installing gnunet-gtk, you can invoke the setup tool and the
 file-sharing GUI with:
 
 $ gnunet-setup
@@ -240,24 +239,22 @@ 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.
 
-In order to run the unit tests with "make check", you need to
+In order to run the unit tests with by hand (instead of using
+"make check"), you need to
 set an environment variable ("GNUNET_PREFIX") to the directory
-where GNUnet is installed (usually, GNUnet will use OS specific
-tricks in order to try to figure out the PREFIX, but since the
-testcase binaries are not installed, that trick does not work
-for them).  Also, before running any testcases, you must
+where GNUnet's libraries are installed.
+Also, before running any testcases, you must
 complete the installation first.  Quick summary:
 
 $ ./configure --prefix=$SOMEWHERE
 $ make
 $ make install
-$ export GNUNET_PREFIX=$SOMEWHERE
 $ make check
 
 Some of the testcases require python >= 2.6 and pexpect to be
-installed.  If any testcases fail to pass on your system, run 
-"contrib/report.sh" and report the output together with 
-information about the failing testcase to the Mantis bugtracking 
+installed.  If any testcases fail to pass on your system, run
+"contrib/report.sh" and report the output together with
+information about the failing testcase to the Mantis bugtracking
 system at https://gnunet.org/bugs/.