]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - README
Unix: Substituted select -> poll also in congestion checker
[thirdparty/bird.git] / README
diff --git a/README b/README
index bbfdf65b54c82e41be38fddec950336c2fb00562..5d4bd9b230eb4b3819d38c037e0a567177f70e46 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,9 @@
-                      BIRD Internet Routing Daemon 0.0.0
+                      BIRD Internet Routing Daemon
 
-               (c) 1998--2000  Martin Mares <mj@ucw.cz>
+               (c) 1998--2008  Martin Mares <mj@ucw.cz>
                 (c) 1998--2000  Pavel Machek <pavel@ucw.cz>
-                (c) 1998--2000  Ondrej Filip <feela@network.cz>
+                (c) 1998--2008  Ondrej Filip <feela@network.cz>
+                (c) 2009--2013  CZ.NIC z.s.p.o.
 
 ================================================================================
 
@@ -11,22 +12,19 @@ systems (but not necessarily limited to them) with full support of all modern
 routing protocols, easy to use configuration interface and powerful route
 filtering language.
 
-BIG FAT WARNING: This is still a development version which probably has lots
-of bugs and missing features (including documentation); see below for what is
-implemented and what still isn't.
+If you want to help us debugging, enhancing and porting BIRD or just lurk
+around to see what's going to develop from this strange creature, feel free
+to subscribe to the BIRD users mailing list (bird-users@bird.network.cz),
+send subscribes to majordomo at the same machine).  Bug reports, suggestions,
+feature requests (: and code :) are welcome.
 
-Welcome to our alpha test team!  If you want to help us debugging, enhancing
-and porting BIRD or just lurking around to see what's going to develop from
-this strange creature, feel free to subscribe to the BIRD users mailing
-list (bird-users@atrey.karlin.mff.cuni.cz, send subscribes to majordomo
-at the same machine).  Bug reports, suggestions, feature requests (: and
-code :) are welcome.
+You can download the latest version from ftp://bird.network.cz/pub/bird/
+and look at the BIRD home page at http://bird.network.cz/.
 
-You can download the latest version from ftp://atrey.karlin.mff.cuni.cz/pub/bird/.
-
-BIRD has been developed as a student project at the Faculty of Math
+BIRD development started as a student project at the Faculty of Math
 and Physics, Charles University, Prague, Czech Republic under supervision
-of RNDr. Libor Forst <forst@cuni.cz>.
+of RNDr. Libor Forst <forst@cuni.cz>. BIRD has been developed and supported
+by CZ.NIC z.s.p.o. http://www.nic.cz/ since 2009.
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -50,16 +48,23 @@ How to install BIRD:
        make install
        vi /usr/local/etc/bird.conf
 
+Online documentation is available as HTML files in the doc directory,
+you can install it by `make install-docs' and rebuild it by `make docs',
+but for the latter you need SGMLtools and LaTeX to be installed on your
+machine. You can also download a neatly formatted PostScript version
+as a separate archive (bird-doc-*.tar.gz).
+
 What do we support:
 
        o  Both IPv4 and IPv6 (use --enable-ipv6 when configuring)
        o  Multiple routing tables
        o  BGP
        o  RIP
-       o  Partial implementation of OSPF (IPv4 only; soon to be
-          functional).
+       o  OSPF
        o  Static routes
        o  Inter-table protocol
+       o  IPv6 router advertisements
+       o  Bidirectional Forwarding Detection (BFD)
        o  Command-line interface (using the `birdc' client; to get
           some help, just press `?')
        o  Soft reconfiguration -- no online commands for changing the
@@ -69,11 +74,9 @@ What do we support:
           protocols affected by the configuration changes.
        o  Powerful language for route filtering (see doc/bird.conf.example).
 
-Missing (see also the TODO file):
-
-       o  Rest of OSPF
-       o  Documentation (see the doc/ directory for a skeleton)
+What is missing:
 
+       o  See the TODO list
 
 Good Luck and enjoy the BIRD :)
                                                The BIRD Team