Update README and HACKING.
[libradsec.git] / lib / README
1 libradsec is a RADIUS library for clients doing RADIUS over UDP or
2 TLS. The goal is to add support for writing servers (and thus
3 proxies) and to add transports TCP and DTLS.
4
5
6 The canonical pickup point is
7 http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
8
9
10 The source code is licensed under a 3-clause BSD license. See LICENSE.
11
12
13 libradsec depends on 
14 - libconfuse
15 - libevent2
16 - openssl (if configured with --enable-tls)
17
18
19 To compile the library and the examples, do something like
20
21  sh autogen.sh && ./configure && make
22
23 If any of the libraries are not found, try setting environment
24 variable LDFLAGS at configure time like so:
25
26   LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
27
28
29 The parts of the library which has been tested has been so on Linux
30 (Debian) with libconfuse (2.7), libevent (2.0.19) and OpenSSL
31 (1.0.1c).
32
33 The file HACKING contains more detailed info on the state of the
34 various parts of the library.