X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=lib%2FREADME;h=4c0d27756aae706a915b093c89c681c48eefd061;hb=67bdfa83f1879312fef0fbac769f6fb45df12d1a;hp=3a2556a5947f580af68aa37a000364ffc587744d;hpb=d12b1b6ba42073b2c5dfe617286b5b3af43df866;p=libradsec.git

diff --git a/lib/README b/lib/README
index 3a2556a..4c0d277 100644
--- a/lib/README
+++ b/lib/README
@@ -1,29 +1,48 @@
-libradsec-0.0.1-dev is a non-working RADIUS library doing UDP, TCP,
-TLS and DTLS.
+Libradsec is a RADIUS library for clients doing RADIUS over UDP or
+TLS. The goal is to add support for writing servers (and thus proxies)
+and to add transports TCP and DTLS.
 
-Canonical pickup point:
+
+The canonical pickup point is
 http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
 
-libradsec depends on 
-- libradius from the FreeRADIUS freeradius-server
-- libevent2
+
+The source code is licensed under a 3-clause BSD license. See the
+LICENSE file.
+
+
+Libradsec depends on 
 - libconfuse
-- openssl (if configured with --enable-tls)
+- libevent2
+- openssl (unless configured with --disable-tls)
 
 
 To compile the library and the examples, do something like
 
- sh autogen.sh && ./configure && make
+  sh autogen.sh && ./configure && make
+
+
+There are a couple of options that can be used when configuring. See
+
+  ./configure --help
+
+for the full list. Worth mentioning here is --enable-tls-psk.
+
+If the preprocessor has a hard time finding some of the header files
+are, try setting environment variable CPPFLAGS at configure
+time. Example:
+
+  CPPFLAGS="-I/usr/local/include" ./configure --enable-tls
 
-If any of the libraries are not found, try setting environment
-variable LDFLAGS at configure time like so:
+If the link editor has trouble finding any of the libraries needed,
+try setting environment variable LDFLAGS at configure time. Example:
 
- LDFLAGS="-L/usr/lib/freeradius -L/usr/local/lib" ./configure
+  LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
 
 
 The parts of the library which has been tested has been so on Linux
-(Ubuntu 10.10) with libfreeradius2 (2.1.9+dfsg-1ubuntu1), libconfuse0
-(2.7-1) and libevent-2.0.10-stable (http://monkey.org/~provos/).
+(Debian) with libconfuse (2.7), libevent (2.0.19) and OpenSSL
+(1.0.1c).
 
 The file HACKING contains more detailed info on the state of the
 various parts of the library.