Add doc/Contributing.txt to distribution archive

[ngircd-alex.git] / README

diff --git a/README b/README
index 7c6140ff98b08a05bb615594d9b22cb099774fb3..11d140d6464b7fb780fa79d9f7c3fa96b2197306 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,8 @@
 
                      ngIRCd - Next Generation IRC Server
 
                      ngIRCd - Next Generation IRC Server

+                           http://ngircd.barton.de/

 
 

-                        (c)2001-2005 Alexander Barton,
-                    alex@barton.de, http://www.barton.de/
-
+               (c)2001-2012 Alexander Barton and Contributors.

                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 
                ngIRCd is free software and published under the
                    terms of the GNU General Public License.
 


@@ -13,11 +12,17 @@
 I. Introduction
 ~~~~~~~~~~~~~~~
 
 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 (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.
+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.
+
+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 :-)
+
+Please see the INSTALL document for installation and upgrade information!

 
 
 II. Status
 
 
 II. Status


@@ -32,41 +37,44 @@ used in real IRC networks.
 
 Implemented IRC-commands are:
 
 
 Implemented IRC-commands are:
 

-ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INVITE, ISON,
-JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE,
-OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER, SQUIT,
-STATS, TIME, TOPIC, TRACE, USER, USERHOST, VERSION, WHO, WHOIS, WHOWAS.
-
+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?)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 III. Features (or: why use ngIRCd?)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

-- no problems with servers which have dynamic IP addresses
-- simple, easy understandable configuration file,
-- freely published open-source C source code,
-- ngIRCd will be developed on in the future.
+- 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.
 - 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
 
 
 IV. Documentation
 ~~~~~~~~~~~~~~~~~
 
 More documentation can be found in the "doc/" directory and the homepage of

-the ngIRCd: <http://arthur.ath.cx/~alex/ngircd/>.
+the ngIRCd: <http://ngircd.barton.de/>.

 
 
 V. Download
 ~~~~~~~~~~~
 
 
 
 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.
+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
 
 If you are interested in the latest development 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".
+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
 
 
 VI. Bugs


@@ -75,13 +83,11 @@ VI. Bugs
 If you find bugs in the ngIRCd (which might be there :-), please report
 them at the following URL:
 
 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>
+<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
 
 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: <alex@barton.de> or <alex@arthur.ath.cx>
-
-
--- 
-$Id: README,v 1.20 2005/06/26 21:54:01 alex Exp $
+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>.