Prepare documentation for release 0.9.0 ...
[ngircd-alex.git] / README
1
2                      ngIRCd - Next Generation IRC Server
3
4                         (c)2001-2005 Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                ngIRCd is free software and published under the
8                    terms of the GNU General Public License.
9
10                                 -- README --
11
12
13 I. Introduction
14 ~~~~~~~~~~~~~~~
15
16 ngIRCd is an Open Source server for the Internet Relay Chat (IRC), which
17 is developed and published under the terms of the GNU General Public
18 Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
19 generation IRC daemon", it's written from scratch and not deduced from the
20 "grandfather of IRC daemons", the daemon of the IRCNet.
21
22
23 II. Status
24 ~~~~~~~~~~~
25
26 It is not the goal of ngIRCd to implement all the nasty behaviours of the
27 original ircd, but to implement most of the useful commands and semantics
28 specified by the RFCs.
29
30 In the meantime ngIRCd should be quite feature complete and stable to be
31 used in real IRC networks.
32
33 Implemented IRC-commands are:
34
35 ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INVITE, ISON,
36 JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE,
37 OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER, SQUIT,
38 STATS, TIME, TOPIC, TRACE, USER, USERHOST, VERSION, WHO, WHOIS, WHOWAS.
39
40
41 III. Features (or: why use ngIRCd?)
42 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
44 - no problems with servers which have dynamic IP addresses
45 - simple, easy understandable configuration file,
46 - freely published open-source C source code,
47 - ngIRCd will be developed on in the future.
48 - wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
49   IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
50
51
52 IV. Documentation
53 ~~~~~~~~~~~~~~~~~
54
55 More documentation can be found in the "doc/" directory and the homepage of
56 the ngIRCd: <http://arthur.ath.cx/~alex/ngircd/>.
57
58
59 V. Download
60 ~~~~~~~~~~~
61
62 The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
63 will find the newest information about the ngIRCd and the most recent
64 ("stable") releases there.
65
66 If you are interested in the latest development versions (which are not
67 always stable), then please read the section "CVS" on the homepage and
68 the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
69 Versioning System".
70
71
72 VI. Bugs
73 ~~~~~~~~
74
75 If you find bugs in the ngIRCd (which might be there :-), please report
76 them at the following URL:
77
78 <http://arthur.ath.cx/~alex/ngircd/#bugs>
79
80 There you can read about known bugs and limitations, too.
81
82 If you have critics, patches or something else, please feel free to post a
83 mail to: <alex@barton.de> or <alex@arthur.ath.cx>
84
85
86 -- 
87 $Id: README,v 1.20 2005/06/26 21:54:01 alex Exp $