Docu: Remove dependency on libradius.

[libradsec.git] / lib / README

diff --git a/lib/README b/lib/README
index 1a47134..51143eb 100644 (file)
--- a/lib/README
+++ b/lib/README
@@ -1,11 +1,36 @@
-This 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.

 
 

-It depends on libradius from FreeRADIUS freeradius-server and
-libevent2.

 
 

-Those parts of the library which has been tested has been so on Linux
-(Ubuntu 10.04) with libfreeradius2 (2.1.8+dfsg-1ubuntu1), libconfuse0
-(2.6-2) and libevent-2.0.7-rc-dev (http://monkey.org/~provos/).
+The canonical pickup point is
+http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
+
+
+The source code is licensed under two different licenses, a 3-clause
+BSD license and the GNU General Public License (version 2 or later).
+Users of this library may choose which of these suits them best.
+
+
+libradsec depends on 
+- libevent2
+- libconfuse
+- openssl (if configured with --enable-tls)
+
+
+To compile the library and the examples, do something like
+
+ sh autogen.sh && ./configure && make
+
+If any of the libraries are not found, try setting environment
+variable LDFLAGS at configure time like so:
+
+ 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/).

 
 The file HACKING contains more detailed info on the state of the
 various parts of the library.
 
 The file HACKING contains more detailed info on the state of the
 various parts of the library.