X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=2e19d831deac91663730963afba874b0f52dd736;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hb=b68bb560e9140c0ec783ea02773aef50d11ac06d;hpb=f4ade537d550b872b7e86e6ffce940dfbad4c60c

diff --git a/README b/README
index e69de29b..2e19d831 100644
--- a/README
+++ b/README
@@ -0,0 +1,90 @@
+
+                     ngIRCd - Next Generation IRC Server
+                           http://ngircd.barton.de/
+
+               (c)2001-2012 Alexander Barton and Contributors.
+               ngIRCd is free software and published under the
+                   terms of the GNU General Public License.
+
+                                -- README --
+
+
+I. Introduction
+~~~~~~~~~~~~~~~
+
+ngIRCd is an Open Source server for the Internet Relay Chat (IRC), which
+is developed and published under the terms of the GNU General Public
+Licence, see the file COPYING for details. ngIRCd means "next generation
+IRC daemon" (which is a little bit exaggerated, "lightweight Internet Relay
+Chat server" would be better), it's written from scratch and not deduced
+from the "grandfather of IRC daemons", the daemon of the IRCNet.
+
+Please see the INSTALL document for installation and upgrade information!
+
+
+II. Status
+~~~~~~~~~~~
+
+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.
+
+In the meantime ngIRCd should be quite feature complete and stable to be
+used in real IRC networks.
+
+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 (or: why use ngIRCd?)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- 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. Documentation
+~~~~~~~~~~~~~~~~~
+
+More documentation can be found in the "doc/" directory and the homepage of
+the ngIRCd: <http://ngircd.barton.de/>.
+
+
+V. Download
+~~~~~~~~~~~
+
+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.
+
+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
+~~~~~~~~
+
+If you find bugs in the ngIRCd (which might be there :-), please report
+them at the following URL:
+
+<http://ngircd.barton.de/bugtracker.php>
+
+There you can read about known bugs and limitations, too.
+
+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>.