-
- 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-2017 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.
-
-Bisher (mehr oder wenig vollstaendig) implementierte IRC-Befehle:
+ngIRCd should be quite feature complete and stable to be used as daemon in
+real world 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.
+It is not the goal of ngIRCd to implement all the nasty behaviors of the
+original ircd, but to implement most of the useful commands and semantics
+specified by the RFCs that are used by existing clients.
-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.4.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.
+- Can use PAM for user authentication.
+- Lots of popular user and channel modes are implemented.
+- Supports "cloaking" of users.
+- 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.:
+More documentation can be found in the "doc/" directory and the homepage of
+ngIRCd: <http://ngircd.barton.de/>.
-- 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
-
-
-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.
+Visit our source code repository at GitHub if you are interested in the
+latest development version: <https://github.com/ngircd/ngircd>.
-VI. Bugs
-~~~~~~~~
+VI. Problems, Bugs, Patches
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Wenn du im ngIRCd Bugs finden solltest (so was soll ja auch vorkommen :-),
-dann lege bitte einen Bug-Report ueber diese URL an:
+Please don't hesitate to contact us if you encounter problems:
-<http://arthur.ath.cx/~alex/ngircd/#bugs>
+- On IRC: <irc://irc.barton.de/ngircd>
+- Via the mailing list: <ngircd-ml@ngircd.barton.de>
-Dort kannst du dich auch ueber bekannte Fehler informieren.
+See <http://ngircd.barton.de/support.php> for details.
-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.
+If you find bugs in ngIRCd (which will be there most probably ...), please
+report them to our issue tracker at GitHub:
+- Bug tracker: <https://github.com/ngircd/ngircd/issues>
+- Patches, "pull requests": <https://github.com/ngircd/ngircd/pulls>
---
-$Id: README,v 1.11 2002/05/19 01:39:43 alex Exp $
+There you can read about known bugs and limitations, too.
projects / ngircd-alex.git / blobdiff