gnurl: README

1 files changed, 37 insertions, 22 deletions

diff --git a/README b/README
index acca440b8..4c3d8259a 100644
--- a/README
+++ b/README
@@ -6,14 +6,14 @@ Compilation requirements:
 * libgnurl must be compiled so that it supports only GnuTLS
   (remove CaySSL, QsoSSL, GSKit, etc.)
 * removed support for NTLM, GSSAPI, SPNEGO, LDAP, metalink, HTTP2
-* Optional, but recommended: GnuTLS build with DANE support
-  (provided by 'unbound')
+* We recommend to build GnuTLS with DANE support, provided by 'unbound'.
+  This is optional.
 
 Changes to the code:
 * renamed the library binary from 'libcurl' to 'lignurl'
-* renamed files to enable a system-wide installation of
-  libgnurl next to libcurl without any collisions
-* adjustments to the testsuite, deleted tests/data/test1139
+* renamed files to ensure a system-wide installation of
+  libgnurl does not result in namespace collisions with libcurl
+* adjustments to the testsuite to address the gnurl specific build
 
 Usage notes:
 * exported symbols were NOT renamed, so they still all have the
@@ -21,28 +21,32 @@ Usage notes:
   by changing -lcurl to -lgnurl.
 
 Note that the compilation requirements are still not fully
-hard-coded, but work on this is in progress since release
-7.56.1-2. If you compile libgnurl, please
-use the following options to configure:
+hardcoded, but work on this is in progress since gnURL 7.56.1-2.
+If you compile libgnurl, please pass '--disable-ntlm-wb' to the
+configure script. So instead of just running
 
-./configure --disable-ntlm-wb
+  ./configure
+
+you will run
+
+  ./configure --disable-ntlm-wb
 
 Naturally, you're free to specify additional options, such as
 "--prefix".  The result should have support only for HTTP, HTTPS (via
 GnuTLS), IDN, zlib and TLS-SRP.
 
-In previous versions (before 7.56.1-2) we used to socially enfore
-the following configuration which was almost never done right on
+In previous versions (gnURL < 7.56.1-2) we used to socially enforce
+the following configuration, which was almost never done right on
 system distribution side:
 
-./configure --enable-ipv6 --with-gnutls --without-libssh2 \
---without-libmetalink --without-winidn --without-librtmp \
---without-nghttp2 --without-nss --without-cyassl \
---without-polarssl --without-ssl --without-winssl \
---without-darwinssl --disable-sspi --disable-ntlm-wb --disable-ldap \
---disable-rtsp --disable-dict --disable-telnet --disable-tftp \
---disable-pop3 --disable-imap --disable-smtp --disable-gopher \
---disable-file --disable-ftp --disable-smb
+  ./configure --enable-ipv6 --with-gnutls --without-libssh2 \
+  --without-libmetalink --without-winidn --without-librtmp \
+  --without-nghttp2 --without-nss --without-cyassl \
+  --without-polarssl --without-ssl --without-winssl \
+  --without-darwinssl --disable-sspi --disable-ntlm-wb --disable-ldap \
+  --disable-rtsp --disable-dict --disable-telnet --disable-tftp \
+  --disable-pop3 --disable-imap --disable-smtp --disable-gopher \
+  --disable-file --disable-ftp --disable-smb
 
 
 Motivation:
@@ -88,13 +92,14 @@ as it is not intended to deal with libraries that have optional
 features. Naturally, installing cURL somewhere else is also
 problematic, as we now need to be really careful that the linker will
 link GNUnet against the right version. Note that none of this can
-really be trivially fixed by the cURL developers.  Rename to Fix
+really be trivially fixed by the cURL developers.
 
+Rename to Fix
 At this point, developers that don't want to rebuild an entire
 distribution from scratch get grumpy. Grumpy developers do silly
 things, like forking code to fix it. I called the fork gnurl (to be
 pronounced with a grumpy voice and an emphasis on the R) as it is bits
-of cURL, a bit more GNUish, for GnuNet, and gnurl can be pronounced to
+of cURL, a bit more GNUish, for GNUnet, and gnurl can be pronounced to
 indicate the grumpy origins.
 
 How does forking fix it? Easy. First, we can get rid of all of the
@@ -134,7 +139,17 @@ required.  Continue to read the cURL documentation --- as libgnurl
 strives for bug-for-bug compatibility with the HTTP/HTTPS/GnuTLS
 subset of cURL.  However, we're happy to add new features relating to
 this core subset and might be easier to convince than the cURL
-developers. ;-)
+developers.
+
+THANKS:
+
+gnURL was started within the GNUnet developer community,
+initiated by Christian Grothoff, with contributions by
+Jeff Burdges and Florian Dold.
+Maintenance and development since 7.52.0 (released 2016-12-21)
+is done by ng0.
+The developers of gnURL express their thanks to the cURL
+developer community.
 
 Now, on to the cURL documentation...