* killed warnings - all are trivial
[olsrd.git] / README
diff --git a/README b/README
index 2eb007f..2a673b2 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 
 +====================================================================+
-| README - olsr.org OLSR daemon 0.4.10, 23.11.05                     |
+| README - olsr.org OLSR daemon 0.5.4rc1, 02.08.2007                    |
 +====================================================================+
 
 Andreas Tonnesen(andreto@olsr.org)
@@ -82,7 +82,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 +113,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,11 +138,6 @@ it with custom actions.
     shared key can participate in the routing.
     You need to have the OpenSSL libs installed to use this plugin.
 
-  - Power plugin. A plugin that uses OLSRs MPR flooding to spread information
-    about the power status of nodes. Meant as an example plugin for code
-    reference only.
-
-
 ========================
  * LINK QUALITY ROUTING
 ========================
@@ -153,11 +151,18 @@ hops. Have a look at the README-Link-Quality.html file for details.
  * KNOWN PROBLEMS
 ==================
 
+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 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. 
@@ -179,6 +184,17 @@ 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
+- 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.
+
+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
 ===========
@@ -190,6 +206,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.
 
 =====================
@@ -202,14 +219,18 @@ olsrd             +/+     +/+     +/+     +/+     +/+     ?
 olsr_switch    +/+     +/+     +/+     +/+     +/+     ?
 ------------------------------------------------------------
 PLUGINS
+bmf            +/+     +/?     +/+     +/+     +/+     ?
 dot_draw       +/+     +/?     +/+     +/+     +/+     ?
 dyn_gw         +/+     +/?     +/-     +/-     +/-     ?
+dyn_gw_plain   +/+     +/?     +/-     +/-     +/-     ?
 httpinfo       +/+     +/+     +/+     +/+     +/+     ?
 mini           +/+     +/?     +/+     +/+     +/+     ?
 nameservice    +/+     +/?     +/+     +/+     +/+     ?
-powerinfo      +/+     +/+     +/-     +/-     +/-     ?
+pgraph         +/+     +/+     +/+     +/+     +/+     ?
+quagga         +/+     -/-     +/+     +/+     +/+     ?
 secure         +/+     +/+     +/+     +/+     +/+     ?
 tas            +/+     -       -       -       -       ?
+txtinfo                +/+     +/+     +/+     +/+     +/+     ?
 ------------------------------------------------------------
 
 LEGEND:   +/+ = compiles/runs
@@ -319,7 +340,7 @@ for details.
 To build olsrd you need to have all the regular development tools 
 installed. This includes gcc, make, glibc, makedep etc.
 To install to a directory different from /(/etc, /usr/bin) use 
-INSTALL_PREFIX=targetdir. To use other compilers set CC=yourcompiler.
+DESTDIR=targetdir. To use other compilers set CC=yourcompiler.
 
 To build:
  make
@@ -439,4 +460,4 @@ limitations with respect to testing and maturity apply. Building and
 installing works in the same was as on FreeBSD.
 
 
-$Id: README,v 1.16 2005/11/23 05:51:07 kattemat Exp $
+$Id: README,v 1.22 2007/09/13 22:52:55 bernd67 Exp $