fix rps
[oweals/gnunet.git] / README
diff --git a/README b/README
index 1ec3b9151a113f3ddc558521c17edc08cd4379bd..7f73525e890912d253be3b901b842d870e3b86df 100644 (file)
--- a/README
+++ b/README
@@ -4,10 +4,13 @@
 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.
@@ -21,31 +24,31 @@ 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.33
+- libmicrohttpd >= 0.9.42
 - libgcrypt     >= 1.6
-- libgnurl      >= 7.34.0 (available from https://gnunet.org/gnurl)
+- libgnurl      >= 7.35.0 (available from https://gnunet.org/gnurl)
 - libunistring  >= 0.9.2
-- gnutls        >= 3.2.11
+- gnutls        >= 3.2.12
 - libidn        >= 1.0
-- libglpk       >= 4.45
+- 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      >= 8.3 (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
@@ -78,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
@@ -94,8 +97,8 @@ 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.
@@ -128,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
@@ -163,7 +166,7 @@ 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 "~/.config/gnunet.conf" or its
 location can be specified by giving the "-c" option to the respective
@@ -236,18 +239,16 @@ 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