X-Git-Url: http://www.project-moonshot.org/gitweb/?p=libradsec.git;a=blobdiff_plain;f=README;h=4c0d27756aae706a915b093c89c681c48eefd061;hp=6646a03ea5e91da1c265adf1c9518f2520dae486;hb=HEAD;hpb=6d3c3558913b01fbcad4ee7f2e55f7d6ab95d1bb

diff --git a/README b/README
index 6646a03..4c0d277 100644
--- a/README
+++ b/README
@@ -1,29 +1,48 @@
-This is radsecproxy 1.4.1 from June 11 2010.
-
-radsecproxy is a generic RADIUS proxy that can support various RADIUS
-clients over UDP or TLS (RadSec).
-
-It should build on most Linux and BSD platforms by simply typing
-"./configure && make".  It is possible to specify which RADIUS
-transport the build should support.  Without any special options to
-configure, all transports supported by the system will be enabled.
-See the output from "configure --help" for how to change this.
-
-To use radsecproxy you need to create a config file which normally is
-called "/etc/radsecproxy.conf".  You can also specify the location
-with the "-c" command line option (see below).  For further
-instructions, please see the enclosed example file and the
-documentation at
-http://software.uninett.no/radsecproxy/?page=documentation
-
-There are five options that may be specified on the command line:
-"-c configfile" to specify a non-default config file path.
-"-d loglevel" to set a loglevel of 1, 2, 3, 4 and 5 where 5 is the
-              most detailed.
-"-f" to run the proxy in the foreground with logging to stderr.
-     Without "-f" the default is to detach as a daemon and log to
-     syslog.
-"-v" just prints version information and exits.
-"-p" (pretend) makes the proxy go through the configuration files as
-     normal, but stops before creating any sockets or doing any
-     serious work.  This is useful for validating config files.
+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.
+
+
+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 (unless configured with --disable-tls)
+
+
+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-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.