Merge branch 'libradsec' into libradsec-server-support
[radsecproxy.git] / lib / README
index e94d40d..acfaf0b 100644 (file)
@@ -1,22 +1,26 @@
-libradsec is a RADIUS library for clients doing RADIUS over UDP or
+Libradsec is a RADIUS library for clients doing RADIUS over UDP or
 TLS. The goal is to eventually add transports TCP and DTLS.
 
+
  * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE * NOTE *
 
 This branch (libradsec-server-support) is extremely unstable and will
-see changes to public API:s for sure. It might even be rebased without
-any warning what so ever. Don't follow this branch.
+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 LICENSE.
+The source code is licensed under a 3-clause BSD license. See the
+LICENSE file.
 
 
-libradsec depends on 
+Libradsec depends on
 - libconfuse
 - libevent2
 - openssl (if configured with --enable-tls)
@@ -27,10 +31,24 @@ For changes between releases, see the CHANGES file.
 
 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 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 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/local/lib" ./configure --enable-tls