]> arthur.barton.de Git - ngircd-alex.git/blobdiff - README
Make configure[.ng] compatible with autoconf 1.10 again
[ngircd-alex.git] / README
diff --git a/README b/README
index 7d6738d769c10fb20dd5f4e54524a3f51b540cc0..c903aa10f7f5a5e981c5bf649f10219f945c2d14 100644 (file)
--- a/README
+++ b/README
-                     ngIRCd - Next Generation IRC Server
 
-                      (c)2001,2002 by Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
+                     ngIRCd - Next Generation IRC Server
+                           http://ngircd.barton.de/
 
-                  ngIRCd ist freie Software und steht unter
-                       der GNU General Public License.
+               (c)2001-2013 Alexander Barton and Contributors.
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
 
-                           -- README / Liesmich --
-                           
-                      Ilja Osthoff, <ilja@glide.ath.cx>
+                                -- 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
+~~~~~~~~~~~~~~~
 
+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.
 
-I. Einfuehrung
-~~~~~~~~~~~~~~
+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 :-)
 
-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.
 
-AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES,
-NICK, NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART,
-SERVER, SQUIT, TOPIC, USER, USERHOST, VERSION, WHO, WHOIS.
+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.
 
-III. Features (oder: warum gerade ngIRCd?)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+III. Features (or: why use 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): A/UX (3.0.1), FreeBSD (4.5),
-  HP-UX (10.20), Linux (2.x), Mac OS X, NetBSD (1.5.2), Solaris (2.5.1) und
-  Windows mit Cygwin.
+- 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. Dokumentation
+IV. Documentation
 ~~~~~~~~~~~~~~~~~
 
-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
-
-- 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-scm.com/).
 
 
 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/bugtracker.php>
 
+There you can read about known bugs and limitations, too.
 
--- 
-$Id: README,v 1.12 2002/05/19 14:55:47 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.barton.de> (please see
+<http://ngircd.barton.de/support.php#ml> for details) or join the ngIRCd
+IRC channel: <irc://irc.barton.de/ngircd>.