]> arthur.barton.de Git - ngircd-alex.git/blobdiff - README
- das Test-Binary wurde nicht immer kopiert.
[ngircd-alex.git] / README
diff --git a/README b/README
index 6f17d5caafae4612984438358520ae2288db1bfa..2b666e63f0dea4e7a7026b1f106dde61567f030d 100644 (file)
--- a/README
+++ b/README
@@ -8,61 +8,98 @@
                        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 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.
+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.
+
 
-Zur Zeit befindet sich der ngIRCd noch in Entwicklung, teilweise fehlen noch
-Features oder sind noch nicht "final" implementiert. 
+II. Status
+~~~~~~~~~~~
 
-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.
+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:
 
-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.
+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, TOPIC, USERHOST,
+USER, 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): 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.
+
+
+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
 
-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. 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.
 
-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 ,-)
+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.
 
 
-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.
+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>
 
-III. Unterstuetzte Plattformen
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Dort kannst du dich auch ueber bekannte Fehler informieren.
 
-- A/UX
-- FreeBSD
-- Linux
-- Mac OS X
-- NetBSD
-- Windows mit Cygwin
+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.
 
 
 -- 
-$Id: README,v 1.6 2002/03/03 13:07:01 alex Exp $
+$Id: README,v 1.13 2002/09/16 11:03:05 alex Exp $