]> arthur.barton.de Git - ngircd-alex.git/blobdiff - README
- Dokumentation aktualisiert.
[ngircd-alex.git] / README
diff --git a/README b/README
index 1ca698709e1e56c62926f1587f508f8574fb510b..7d6738d769c10fb20dd5f4e54524a3f51b540cc0 100644 (file)
--- a/README
+++ b/README
-
                      ngIRCd - Next Generation IRC Server
 
-                         (c)2001 by Alexander Barton,
+                      (c)2001,2002 by 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>
+
+
+ +-----------------------------------------------------------------------+
+ | Please note: English translations of some of the german documentation |
+ | files can be found in the directory "doc/en" -- please have a look!   |
+ +-----------------------------------------------------------------------+
+
+
+I. Einfuehrung
+~~~~~~~~~~~~~~
 
+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.
 
-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.
 
-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 ;-)
+II. Status
+~~~~~~~~~~~
 
-Diese Version ist aber auf jeden Fall als "Preview" anzusehen!
+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:
 
-DIE, ISON, MODE, MOTD, NAMES, NICK, NOTICE, OPER, PASS, PING, PONG, PRIVMSG,
-QUIT, RESTART, USER, USERHOST, WHOIS.
+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.
+
+
+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): 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.
+
+
+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
+
+- doc/en/: englischsprachige Dokumentation
+
+
+V. Bezugsquellen
+~~~~~~~~~~~~~~~~
+
+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.
+
+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.
+
+
+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:
 
-Ueber Rueckmeldungen, Bug-Reports und Patches freue ich mich! Also los, haut
-in die Tasten! :-))
+<http://arthur.ath.cx/~alex/ngircd/#bugs>
 
-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/>.
+Dort kannst du dich auch ueber bekannte Fehler informieren.
 
-[ ... more to come ... ]
+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.
 
 
-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 ,-)
+-- 
+$Id: README,v 1.12 2002/05/19 14:55:47 alex Exp $