X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=c903aa10f7f5a5e981c5bf649f10219f945c2d14;hp=1ca698709e1e56c62926f1587f508f8574fb510b;hb=a14eb495b75c8c2a2a32ddb6eecf50dc174f811c;hpb=194f18c8e69e42ea7476f21514642833e090c426

diff --git a/README b/README
index 1ca69870..c903aa10 100644
--- a/README
+++ b/README
@@ -1,42 +1,93 @@
 
                      ngIRCd - Next Generation IRC Server
+                           http://ngircd.barton.de/
 
-                         (c)2001 by Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
+               (c)2001-2013 Alexander Barton and Contributors.
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
 
-                  ngIRCd ist freie Software und steht unter
-                       der GNU General Public License.
+                                -- README --
 
-                           -- README / Liesmich --
 
+I. Introduction
+~~~~~~~~~~~~~~~
 
-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.
+ngIRCd is a free, portable and lightweight Internet Relay Chat server for
+small or private networks, developed under the GNU General Public License
+(GPL; please see the file COPYING for details). It is simple to configure,
+can cope with dynamic IP addresses, and supports IPv6 as well as SSL. It is
+written from scratch and not based on the original IRCd.
 
-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 ;-)
+The name ngIRCd means next generation IRC daemon, which is a little bit
+exaggerated: lightweight Internet Relay Chat server most probably would be a
+better name :-)
 
-Diese Version ist aber auf jeden Fall als "Preview" anzusehen!
+Please see the INSTALL document for installation and upgrade information!
 
-Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle:
 
-DIE, ISON, MODE, MOTD, NAMES, NICK, NOTICE, OPER, PASS, PING, PONG, PRIVMSG,
-QUIT, RESTART, USER, USERHOST, WHOIS.
+II. Status
+~~~~~~~~~~~
 
-Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut
-in die Tasten! :-))
+It is not the goal of ngIRCd to implement all the nasty behaviours of the
+original ircd, but to implement most of the useful commands and semantics
+specified by the RFCs.
 
-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/>.
+In the meantime ngIRCd should be quite feature complete and stable to be
+used in real IRC networks.
 
-[ ... more to come ... ]
+Implemented IRC-commands are:
 
+ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, GLINE, HELP, INFO,
+INVITE, ISON, JOIN, KICK, KILL, KLINE, LINKS, LIST, LUSERS, MODE, MOTD,
+NAMES, NICK, NJOIN, NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT,
+REHASH, RESTART, SERVER, SERVICE, SERVLIST, SQUERY, SQUIT, STATS, SUMMON,
+TIME, TOPIC, TRACE, USER, USERHOST, USERS, VERSION, WALLOPS, WEBIRC, WHO,
+WHOIS, WHOWAS.
 
-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 ,-)
+III. Features (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- well arranged (lean) configuration file
+- simple to build/install, configure and maintain
+- supports IPv6 and SSL
+- no problems with servers that have dynamic IP addresses
+- freely available, modern, portable and tidy C-source
+- wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
+  IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
+- ngIRCd is being actively developed since 2001.
+
+
+IV. Documentation
+~~~~~~~~~~~~~~~~~
+
+More documentation can be found in the "doc/" directory and the homepage of
+the ngIRCd: <http://ngircd.barton.de/>.
+
+
+V. Download
+~~~~~~~~~~~
+
+The homepage of the ngIRCd is: <http://ngircd.barton.de/>; 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 about "GIT" on the homepage and
+the file "doc/GIT.txt" which describes the use of GIT, the version control
+system used by ngIRCd (homepage: http://git-scm.com/).
+
+
+VI. Bugs
+~~~~~~~~
+
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
+
+<http://ngircd.barton.de/bugtracker.php>
+
+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 the ngIRCd mailing list: <ngircd-ml@arthur.barton.de> (please see
+<http://ngircd.barton.de/support.php#ml> for details) or join the ngIRCd
+IRC channel: <irc://irc.barton.de/ngircd>.