* fixed a bug in the olsr_netmask_to_prefix() function which produced
[olsrd.git] / README
diff --git a/README b/README
index d833bb5..3726a4f 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,17 @@
 
 +====================================================================+
-| README - olsr.org OLSR daemon 0.5.0, 02.04.2007                    |
+| README - olsr.org OLSR daemon 0.5.4, 21.10.2007                    |
 +====================================================================+
 
+Authors:
 Andreas Tonnesen(andreto@olsr.org)
 Thomas Lopatic  (thomas@lopatic.de)
+Aaron Kaplan (aaron@lo-res.org)
+
 
 http://www.olsr.org
 
+
 CONTENTS:
 
 I.   - GENERAL INFORMATION
@@ -59,6 +63,9 @@ http://sourceforge.net/projects/olsrd/
 Olsrd source or binaries can be downloaded from olsr.org. CVS is available
 for the cutting edge features ;-)
 
+The current Olsrd work is done via http://olsr.funkfeuer.at/ in the OLSR-NG
+project.
+
 
 =================
  * RELEASE NOTES
@@ -82,7 +89,7 @@ olsr.org.
  * PLUGINS
 ===========
 
-Olsrd supports dynamic loading of plugins(dynamically loaded libraries) for 
+Olsrd supports dynamic loading of plugins (dynamically loaded libraries) for 
 functions like generation and processing of private package types, setting
 olsrd configurations in run-time and much more. This design is chosen for
 amongst others, the following reasons:
@@ -113,11 +120,14 @@ it with custom actions.
 
   Plugins that are part of this release(can be found in the lib/ directory):
 
-  - Tiny Application Server(TAS).
+  - Tiny Application Server (TAS).
 
   - HttpInfo. This plugin implements a simple HTTP server that serves dynamic
     pages with lots of information about the running olsrd process.
 
+  - TxtInfo. This delivers output similar to the above. However, it is intended
+    for external tools to use the output.
+
   - Mini.
 
   - Nameservice.
@@ -135,6 +145,8 @@ it with custom actions.
     shared key can participate in the routing.
     You need to have the OpenSSL libs installed to use this plugin.
 
+
+
 ========================
  * LINK QUALITY ROUTING
 ========================
@@ -150,18 +162,19 @@ hops. Have a look at the README-Link-Quality.html file for details.
 
 There is no synchronization concept (and thus - and for Gods sake -  no
 code). Some plugins use threads for concurrency so this should be solved.
+ATM the bmf plugin is the only one using threads.
 
 ===============
  * FUTURE WORK
 ===============
 
-Future work concentrates on reduction of ressource (ab)use nad to make
+Future work concentrates on reduction of ressource (ab)use and to make
 it more scalable. Of course additional useful plugins are always
 appreciated.
 
-Future releases of the 0.4 series will be maintainance releases focused
-on bugfixing. Work will soon begin on a 0.5 series where we will focus
-much more on new ideas. 0.4 and 0.5 might coexist for some time. 
+The current track of development is documented in the OLSR-NG 
+project: http://olsr.funkfeuer.at
+
 
 ----------------------------------------------------------------------
  II.  - BUILDING AND RUNNING OLSRD
@@ -180,6 +193,20 @@ known to run on various hardware like:
 A binary tarball featuring x86, MIPSEL and ARM binaries is available
 for download at olsr.org
 
+Ports exist for all major operating systems:
+- Linux
+- Mac OS X
+- NetBSD/OpenBSD/FreeBSD: ATM the main development occurs on Linux with
+         GNU tools so occasionally it needs some minor tweaks to compile
+         it on *BSD. Please send patches if you fix problems there.
+- Win32: You need (the relevant parts of) cygwin to compile the daemon
+         as such. The installer and GUI needs VisualC++ though.
+         Win32 is the least supported port. Feel free to send patches!
+
+Packages for the operating systems and various distributions are available
+at olsr.org. Feel free to package it and announce it on the mailing lists.
+
+
 ===========
  * PLUGINS
 ===========
@@ -191,6 +218,7 @@ Building the plugins are just a matter of executing:
 make
 while installing requires(as root):
 make install
+in the plugins top directory (i.e. "lib/$plugin/").
 To use the plugins add them to the olsrd configuration file.
 
 =====================
@@ -203,18 +231,18 @@ olsrd             +/+     +/+     +/+     +/+     +/+     ?
 olsr_switch    +/+     +/+     +/+     +/+     +/+     ?
 ------------------------------------------------------------
 PLUGINS
-bmf            +/+     +/?     +/+     +/+     +/+     ?
-dot_draw       +/+     +/?     +/+     +/+     +/+     ?
-dyn_gw         +/+     +/?     +/-     +/-     +/-     ?
-dyn_gw_plain   +/+     +/?     +/-     +/-     +/-     ?
-httpinfo       +/+     +/+     +/+     +/+     +/+     ?
-mini           +/+     +/?     +/+     +/+     +/+     ?
-nameservice    +/+     +/?     +/+     +/+     +/+     ?
-pgraph         +/+     +/+     +/+     +/+     +/+     ?
+bmf            +/+     +/?     +/+     +/+     +/+     -
+dot_draw       +/+     +/?     +/+     +/+     +/+     +/+
+dyn_gw         +/+     +/?     +/-     +/-     +/-     +/+
+dyn_gw_plain   +/+     +/?     +/-     +/-     +/-     +/+
+httpinfo       +/+     +/+     +/+     +/+     +/+     +/+
+mini           +/+     +/?     +/+     +/+     +/+     +/+
+nameservice    +/+     +/?     +/+     +/+     +/+     +/+
+pgraph         +/+     +/+     +/+     +/+     +/+     +/+
 quagga         +/+     -/-     +/+     +/+     +/+     ?
-secure         +/+     +/+     +/+     +/+     +/+     ?
+secure         +/+     +/+     +/+     +/+     +/+     +/+
 tas            +/+     -       -       -       -       ?
-txtinfo                +/+     +/+     +/+     +/+     +/+     ?
+txtinfo                +/+     +/+     +/+     +/+     +/+     +/+
 ------------------------------------------------------------
 
 LEGEND:   +/+ = compiles/runs
@@ -444,4 +472,4 @@ limitations with respect to testing and maturity apply. Building and
 installing works in the same was as on FreeBSD.
 
 
-$Id: README,v 1.18 2007/04/03 08:46:44 bernd67 Exp $
+$Id: README,v 1.23 2007/10/21 21:16:11 ipo23 Exp $