- Dokumentation aktualisiert (u.a. englische Versionen)

[ngircd-alex.git] / doc / en / README

diff --git a/doc/en/README b/doc/en/README
new file mode 100644 (file)
index 0000000..427fbf7
--- /dev/null
+++ b/doc/en/README
@@ -0,0 +1,99 @@
+                     ngIRCd - Next Generation IRC Server
+
+                      (c)2001,2002 by Alexander Barton,
+                    alex@barton.de, http://www.barton.de/
+
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
+
+                                -- README --
+                           
+                      Ilja Osthoff, <ilja@glide.ath.cx>
+
+
+I. Introduction
+~~~~~~~~~~~~~~~
+
+ngIRCd is an Open-Source server for the Internet Realy Chat (IRC), which
+is developped 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.
+
+
+
+II. Status
+~~~~~~~~~~~
+
+At present, the ngIRCd is under active development, some features are not
+implemented, some only partly.
+
+Till tody (more or less complete) implemented IRC-commands:
+
+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 (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- no problems with servers which have dynamic ip-adresses
+- simple, easy understandable configuration file,
+- freely published C-Sourcecode,
+- ngIRCd will be developed on in the future.
+- supported platforms: A/UX; FreeBSD, Linux, MAC OS X/Darwin and Windows
+  with Cygwin
+
+
+IV. Documentation
+~~~~~~~~~~~~~~~~~
+
+English documentation:
+
+- doc/en/README: the file that you are reading :-)
+- doc/en/INSTALL: hints for the installation of the ngIRCd
+
+German documentation:
+
+- README: readme text in german
+- INSTALL: german installation instructions
+- NEWS: what do you think? :-) 
+- Changelog: the complete history of the ngIRCd
+- doc/FAQ.txt: frequently asked questions and answers
+- doc/CVS.txt: hints for the CVS-system
+- doc/RFC.txt: information about the RFC's
+- doc/sample-ngircd.conf: sample configuration file
+- doc/README-AUX.txt: installation hints for A/UX
+- doc/README-BeOS.txt: the same for BeOS
+
+
+V. Download
+~~~~~~~~~~~
+
+The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
+will find the newest information about the ngIRCd and the most recent
+("stable") releases there.
+
+If you are interested in the newest developper-versions (which are not
+always stable), then please read the section "CVS" on the homepage and
+the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
+Versioning System".
+
+
+VI. Bugs
+~~~~~~~~
+
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
+
+<http://arthur.ath.cx/~alex/ngircd/#bugs>
+
+There you can read about kown bugs, too.
+
+If you have critics, patches or something else, please feel yourself free
+to post a mail to: <alex@barton.de> or <alex@arthur.ath.cx>
+
+
+-- 
+$Id: README,v 1.1 2002/05/08 15:43:00 alex Exp $