Updated manual page.

[ngircd-alex.git] / README

diff --git a/README b/README
index 625bca03484a5535c8273a11efefe4ce9b5bea87..1be06e0b5f20e45a38f063057d2fda60a29f312b 100644 (file)
--- a/README
+++ b/README
@@ -1,42 +1,86 @@
 
                      ngIRCd - Next Generation IRC Server
 
-                      (c)2001,2002 by Alexander Barton,
+                      (c)2001-2003 by Alexander Barton,
                     alex@barton.de, http://www.barton.de/
 
-                  ngIRCd ist freie Software und steht unter
-                       der GNU General Public License.
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
 
-                           -- README / Liesmich --
+                                -- README --
+                           
+                      Ilja Osthoff, <ilja@glide.ath.cx>
 
 
-ngIRCd ist ein Server fuer den Internet Relay Chat (IRC). Er ist von Grund
-auf neu geschrieben, also nicht wie die meisten anderen IRCd's vom Urvater,
-dem Daemon des IRCNet abgeleitet.
+I. Introduction
+~~~~~~~~~~~~~~~
 
-Zur Zeit befindet sich ngIRCd noch in Entwicklung, vieles ist noch nicht
-implementiert bzw. nur "halbherzig": Channels gibt es noch nicht, genau so
-wenig wie Server-Links. Das private Chatten (PRIVMSG) mit den Client-Befehlen
-/msg und /query sollte hingegen funktionieren, ein wenig praktische Funk-
-tionalitaet ist also tatsaechlich schon vorhanden ;-)
+ngIRCd is an Open-Source server for the Internet Relay Chat (IRC), which
+is developed and published under the terms of the GNU General Public
+Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
+generation IRC daemon", it's written from scratch and not deduced from the
+"grandfather of IRC daemons", the daemon of the IRCNet.
 
-Diese Version ist aber auf jeden Fall als "Preview" anzusehen!
 
-Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle:
+II. Status
+~~~~~~~~~~~
 
-DIE, ISON, MODE, MOTD, NAMES, NICK, NOTICE, OPER, PASS, PING, PONG, PRIVMSG,
-QUIT, RESTART, USER, USERHOST, WHOIS.
+At present, the ngIRCd is under active development, some features are not
+implemented, some only partly.
 
-Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut
-in die Tasten! :-))
+Till today (more or less complete) implemented IRC-commands:
 
-Via E-Mail erreichst du mich als <alex@arthur.ath.cx> bzw. <alex@barton.de>.
-Die Homepage des ngIRCd findest du unter <http://arthur.ath.cx/~alex/ngircd/>.
+ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INVITE, ISON,
+JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN,
+NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER,
+SQUIT, STATS, TIME, TOPIC, TRACE, USER, USERHOST, VERSION, WHO, WHOIS.
 
-[ ... more to come ... ]
 
+III. Features (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Hinweise zur Installation findest du in der Datei INSTALL.
-Alle Autoren von ngIRCd sind in AUTHORS aufgefuehrt.
-In der Datei COPYING steht die GNU General Public License.
-Das README liest du gerade ,-)
+- no problems with servers which have dynamic IP addresses
+- simple, easy understandable configuration file,
+- freely published open-source C source code,
+- ngIRCd will be developed on in the future.
+- supported platforms (tested versions): AIX (3.2.5), A/UX (3.0.1), FreeBSD
+  (4.5), HP-UX (10.20), IRIX (6.5), Linux (2.x), Mac OS X (10.x), NetBSD
+  (1.5.2/i386, 1.5.3/m68k), Solaris (2.5.1, 2.6), and Windows with Cygwin.
+
+
+IV. Documentation
+~~~~~~~~~~~~~~~~~
+
+More documentation can be found in the "doc/" directory and the homepage of
+the ngIRCd: <http://arthur.ath.cx/~alex/ngircd/>.
+
+
+V. Download
+~~~~~~~~~~~
+
+The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
+will find the newest information about the ngIRCd and the most recent
+("stable") releases there.
+
+If you are interested in the latest development versions (which are not
+always stable), then please read the section "CVS" on the homepage and
+the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
+Versioning System".
+
+
+VI. Bugs
+~~~~~~~~
+
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
+
+<http://arthur.ath.cx/~alex/ngircd/#bugs>
+
+There you can read about known bugs and limitations, too.
+
+If you have critics, patches or something else, please feel free to post a
+mail to: <alex@barton.de> or <alex@arthur.ath.cx>
+
+
+-- 
+$Id: README,v 1.17 2003/03/09 22:03:58 alex Exp $