Update NEWS and ChangeLog files
[ngircd-alex.git] / README
1
2                      ngIRCd - Next Generation IRC Server
3                            http://ngircd.barton.de/
4
5                (c)2001-2012 Alexander Barton and Contributors.
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                 -- README --
10
11
12 I. Introduction
13 ~~~~~~~~~~~~~~~
14
15 ngIRCd is an Open Source server for the Internet Relay Chat (IRC), which
16 is developed and published under the terms of the GNU General Public
17 Licence, see the file COPYING for details. ngIRCd means "next generation
18 IRC daemon" (which is a little bit exaggerated, "lightweight Internet Relay
19 Chat server" would be better), it's written from scratch and not deduced
20 from the "grandfather of IRC daemons", the daemon of the IRCNet.
21
22 Please see the INSTALL document for installation and upgrade information!
23
24
25 II. Status
26 ~~~~~~~~~~~
27
28 It is not the goal of ngIRCd to implement all the nasty behaviours of the
29 original ircd, but to implement most of the useful commands and semantics
30 specified by the RFCs.
31
32 In the meantime ngIRCd should be quite feature complete and stable to be
33 used in real IRC networks.
34
35 Implemented IRC-commands are:
36
37 ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, GLINE, HELP, INFO,
38 INVITE, ISON, JOIN, KICK, KILL, KLINE, LINKS, LIST, LUSERS, MODE, MOTD,
39 NAMES, NICK, NJOIN, NOTICE, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT,
40 REHASH, RESTART, SERVER, SERVICE, SERVLIST, SQUERY, SQUIT, STATS, SUMMON,
41 TIME, TOPIC, TRACE, USER, USERHOST, USERS, VERSION, WALLOPS, WEBIRC, WHO,
42 WHOIS, WHOWAS.
43
44 III. Features (or: why use ngIRCd?)
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46
47 - well arranged (lean) configuration file
48 - simple to build/install, configure and maintain
49 - supports IPv6 and SSL
50 - no problems with servers that have dynamic IP addresses
51 - freely available, modern, portable and tidy C-source
52 - wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
53   IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
54 - ngIRCd is being actively developed since 2001.
55
56
57 IV. Documentation
58 ~~~~~~~~~~~~~~~~~
59
60 More documentation can be found in the "doc/" directory and the homepage of
61 the ngIRCd: <http://ngircd.barton.de/>.
62
63
64 V. Download
65 ~~~~~~~~~~~
66
67 The homepage of the ngIRCd is: <http://ngircd.barton.de/>; you will find
68 the newest information about the ngIRCd and the most recent ("stable")
69 releases there.
70
71 If you are interested in the latest development versions (which are not
72 always stable), then please read the section about "GIT" on the homepage and
73 the file "doc/GIT.txt" which describes the use of GIT, the version control
74 system used by ngIRCd (homepage: http://git-scm.com/).
75
76
77 VI. Bugs
78 ~~~~~~~~
79
80 If you find bugs in the ngIRCd (which might be there :-), please report
81 them at the following URL:
82
83 <http://ngircd.barton.de/bugtracker.php>
84
85 There you can read about known bugs and limitations, too.
86
87 If you have critics, patches or something else, please feel free to post a
88 mail to the ngIRCd mailing list: <ngircd-ml@arthur.barton.de> (please see
89 <http://ngircd.barton.de/support.php#ml> for details) or join the ngIRCd
90 IRC channel: <irc://irc.barton.de/ngircd>.