X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=f01e6d60a04032f397fdec98b998e46544cf4e4f;hp=6f17d5caafae4612984438358520ae2288db1bfa;hb=7c82cc236b715ff35cd00447a730f473c8555ada;hpb=e7214c151fb7d957c870d1ab169ede460687f034

diff --git a/README b/README
index 6f17d5ca..f01e6d60 100644
--- a/README
+++ b/README
@@ -1,68 +1,91 @@
- 
+
                      ngIRCd - Next Generation IRC Server
 
-                      (c)2001,2002 by Alexander Barton,
+                        (c)2001-2007 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 --
+
+
+I. Introduction
+~~~~~~~~~~~~~~~
+
+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.
+
+Please see the INSTALL document for installation and upgrade information!
+
+
+II. Status
+~~~~~~~~~~~
+
+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.
+
+In the meantime ngIRCd should be quite feature complete and stable to be
+used in real IRC networks.
 
-                           -- README / Liesmich --
+Implemented IRC-commands are:
 
+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, WALLOPS, WHO, WHOIS,
+WHOWAS.
 
-I. Einfuehrung
-~~~~~~~~~~~~~~
 
-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.
+III. Features (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Zur Zeit befindet sich der ngIRCd noch in Entwicklung, teilweise fehlen noch
-Features oder sind noch nicht "final" implementiert. 
+- 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.
+- wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
+  IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
 
-Channels sind inzwischen implementiert (seit Version 0.1.0), privates Chatten
-mit /msg und /query funktioniert ebenso. Server-Links werden dabei unter-
-stuetzt. Einige User- und Channel-Modes sind implementiert, hier kennt der
-Server jedoch noch nicht alles.
 
-Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle:
+IV. Documentation
+~~~~~~~~~~~~~~~~~
 
-AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LUSERS, MODE, MOTD, NAMES, NICK,
-NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER,
-SQUIT, TOPIC, USER, USERHOST, VERSION, WHOIS.
+More documentation can be found in the "doc/" directory and the homepage of
+the ngIRCd: <http://ngircd.barton.de/>.
 
-Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut
-in die Tasten! :-))
 
-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/>.
+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.
 
-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 ,-)
+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".
 
 
-II. Vorteile
-~~~~~~~~~~~~
+VI. Bugs
+~~~~~~~~
 
-- keine Probleme mit Servern, deren IP-Adressen nicht statisch sind,
-- übersichtliche ("schlanke") Konfigurationsdatei,
-- frei verfügbarer, moderner und "aufgeräumter" C-Quellcode.
-- ngIRCd wird aktiv weiter entwickelt.
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
 
+<http://ngircd.barton.de/#bugs>
 
-III. Unterstuetzte Plattformen
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+There you can read about known bugs and limitations, too.
 
-- A/UX
-- FreeBSD
-- Linux
-- Mac OS X
-- NetBSD
-- Windows mit Cygwin
+If you have critics, patches or something else, please feel free to post a
+mail to the ngIRCd mailing list: <ngircd-ml@arthur.ath.cx> (please see
+<http://ngircd.barton.de/#ml> for details).
 
 
 -- 
-$Id: README,v 1.6 2002/03/03 13:07:01 alex Exp $
+$Id: README,v 1.25 2007/10/04 15:18:48 alex Exp $