]> arthur.barton.de Git - ngircd-alex.git/blobdiff - README
Console log: output timestamp (seconds since start of daemon)
[ngircd-alex.git] / README
diff --git a/README b/README
index abb02292e584fac97b1991e63e5a8dbba11915cb..2eff7bce0c34d5fcd726dfd4a002179f2aeaec2b 100644 (file)
--- a/README
+++ b/README
+
                      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.
-
-                           -- README / Liesmich --
-                           
-                      Ilja Osthoff, <ilja@glide.ath.cx>
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
 
+                                -- README --
 
- +-----------------------------------------------------------------------+
- | Please note: English translations of some of the german documentation |
- | files can be found in the directory "doc/en" -- please have a look!   |
- +-----------------------------------------------------------------------+
 
+I. Introduction
+~~~~~~~~~~~~~~~
 
-I. Einfuehrung
-~~~~~~~~~~~~~~
+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.
 
-ngIRCd ist ein Open-Source-Server fuer den Internet Relay Chat (IRC), der
-unter der GNU General Public License (http://www.gnu.org/licenses/gpl.html)
-entwickelt wird. ngIRCd steht fuer "next generation IRC daemon", er ist von
-Grund auf neu geschrieben, also nicht wie die meisten anderen IRCd's vom
-Urvater, dem Daemon des IRCNet abgeleitet.
+Please see the INSTALL document for installation and upgrade information!
 
 
 II. Status
 ~~~~~~~~~~~
 
-Zur Zeit befindet sich der ngIRCd noch in Entwicklung, manche Features sind
-noch nicht implementiert, andere nur teilweise.
+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.
 
-Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle:
+In the meantime ngIRCd should be quite feature complete and stable to be
+used in real IRC networks.
 
-ADMIN, AWAY, CHANINFO, CONNECT, DIE, ERROR, INVITE, ISON, JOIN, KICK, KILL,
-LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE, OPER, PART,
-PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER, SQUIT, TIME, TOPIC,
-USERHOST, USER, VERSION, WHO, WHOIS.
+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.
 
-III. Features (oder: warum gerade ngIRCd?)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- keine Probleme mit Servern, deren IP-Adresse dynamisch ist,
-- einfache, uebersichtliche Konfigurationsdatei,
-- frei verfuegbarer C-Quellcode.
-- ngIRCd wird aktiv weiterentwickelt.
-- unterstuetzte Plattformen (getestete Version): AIX (3.2.5), A/UX (3.0.1),
-  FreeBSD/i386 (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), Windows mit Cygwin.
+III. Features (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+- 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.
 
-IV. Dokumentation
-~~~~~~~~~~~~~~~~~
-
-Im Paket enthalten ist u.a.:
 
-- README: das Dokument, das Du gerade liest :-)
-- INSTALL: Hinweise zur Installation des ngIRCd
-- NEWS: sagt der Name schon :-)
-- ChangeLog: die komplette History des ngIRCd
-- doc/FAQ.txt: haeufige Fragen und Antworten zum ngIRCd
-- doc/CVS.txt: Hinweise zum CVS-System
-- doc/RFC.txt: Infos ueber die RFC's
-- doc/sample-ngircd.conf: Beispiel-Konfigurationsdatei
-- doc/README-AUX.txt: Installationshinweise fuer A/UX
-- doc/README-BeOS.txt: dito fuer BeOS
+IV. Documentation
+~~~~~~~~~~~~~~~~~
 
-- doc/en/: englischsprachige Dokumentation
+More documentation can be found in the "doc/" directory and the homepage of
+the ngIRCd: <http://ngircd.barton.de/>.
 
 
-V. Bezugsquellen
-~~~~~~~~~~~~~~~~
+V. Download
+~~~~~~~~~~~
 
-Die Homepage des ngIRCd ist: <http://arthur.ath.cx/~alex/ngircd>; dort
-findest du immer die neusten Informationen ueber den ngIRCd und die aktuellen
-freigegebenen ("stabilen") Releases.
+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.
 
-Falls du dich fuer die aktuellen Entwicklungs-Versionen (die jedoch nicht
-immer "stabil" sind) interessierst, dann lese bitte den Punkt "CVS" auf der
-Homepage und die Datei "doc/CVS.txt", die die Verwendung des "Concurrent
-Versioning System" (CVS) beschreibt.
+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.or.cz/).
 
 
 VI. Bugs
 ~~~~~~~~
 
-Wenn du im ngIRCd Bugs finden solltest (so was soll ja auch vorkommen :-),
-dann lege bitte einen Bug-Report ueber diese URL an:
-
-<http://arthur.ath.cx/~alex/ngircd/#bugs>
-
-Dort kannst du dich auch ueber bekannte Fehler informieren.
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
 
-Falls du noch Anregungen, Kritik, Patches etc. pp. zum ngIRCd hast, dann
-bitte einfach eine Mail an <alex@barton.de> oder <alex@arthur.ath.cx>
-schreiben.
+<http://ngircd.barton.de/#bugs>
 
+There you can read about known bugs and limitations, too.
 
--- 
-$Id: README,v 1.14 2002/11/24 18:48:59 alex Exp $
+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).