Merge branch 'libradsec' into libradsec-server-support

[radsecproxy.git] / lib / README

diff --git a/lib/README b/lib/README
index e221bf1..acfaf0b 100644 (file)
--- a/lib/README
+++ b/lib/README
@@ -1,11 +1,61 @@
-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 eventually 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) and
-libevent-2.0.7-rc-dev (http://monkey.org/~provos/).
+ * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE *
+
+This branch (libradsec-server-support) is extremely unstable and will
+see changes its to public API:s for sure. It _will_ be rebased without
+any warning what so ever. Yuo probably don't want to follow this
+branch.
+
+ * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE *
+
+
+The canonical pickup point is
+http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
+
+
+The source code is licensed under a 3-clause BSD license. See the
+LICENSE file.
+
+
+Libradsec depends on
+- libconfuse
+- libevent2
+- openssl (if configured with --enable-tls)
+
+
+For changes between releases, see the CHANGES file.
+
+
+To compile the library and the examples, do something like
+
+  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 and
+--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 the link editor has trouble finding any of the libraries needed,
+try setting environment variable LDFLAGS at configure time. Example:
+
+  LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
+
+
+The parts of the library which has been tested has been so on Linux
+(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.