1 93146b57 2003-03-04 alex 
 2 194f18c8 2001-12-31 alex                      ngIRCd - Next Generation IRC Server
 3 6d11fb14 2011-01-09 alex                            http://ngircd.barton.de/
 4 194f18c8 2001-12-31 alex 
 5 34bdb0d9 2018-02-09 alex                (c)2001-2018 Alexander Barton and Contributors.
 6 f39d6285 2003-01-04 alex                ngIRCd is free software and published under the
 7 f39d6285 2003-01-04 alex                    terms of the GNU General Public License.
 8 194f18c8 2001-12-31 alex 
 9 f39d6285 2003-01-04 alex                                 -- README --
10 194f18c8 2001-12-31 alex 
11 194f18c8 2001-12-31 alex 
12 f39d6285 2003-01-04 alex I. Introduction
13 f39d6285 2003-01-04 alex ~~~~~~~~~~~~~~~
14 cfe1893d 2002-05-08 alex 
15 53b2acc0 2012-09-04 alex ngIRCd is a free, portable and lightweight Internet Relay Chat server for
16 53b2acc0 2012-09-04 alex small or private networks, developed under the GNU General Public License
17 53b2acc0 2012-09-04 alex (GPL; please see the file COPYING for details). It is simple to configure,
18 53b2acc0 2012-09-04 alex can cope with dynamic IP addresses, and supports IPv6 as well as SSL. It is
19 53b2acc0 2012-09-04 alex written from scratch and not based on the original IRCd.
20 cfe1893d 2002-05-08 alex 
21 53b2acc0 2012-09-04 alex The name ngIRCd means next generation IRC daemon, which is a little bit
22 53b2acc0 2012-09-04 alex exaggerated: lightweight Internet Relay Chat server most probably would be a
23 53b2acc0 2012-09-04 alex better name :-)
24 53b2acc0 2012-09-04 alex 
25 22a9ed66 2007-05-20 alex Please see the INSTALL document for installation and upgrade information!
26 e7214c15 2002-03-03 alex 
27 22a9ed66 2007-05-20 alex 
28 cfe1893d 2002-05-08 alex II. Status
29 cfe1893d 2002-05-08 alex ~~~~~~~~~~~
30 e7214c15 2002-03-03 alex 
31 055d6e80 2016-01-06 alex ngIRCd should be quite feature complete and stable to be used as daemon in
32 055d6e80 2016-01-06 alex real world IRC networks.
33 055d6e80 2016-01-06 alex 
34 cb3a4321 2015-09-06 alex It is not the goal of ngIRCd to implement all the nasty behaviors of the
35 eeccc193 2005-06-26 alex original ircd, but to implement most of the useful commands and semantics
36 055d6e80 2016-01-06 alex specified by the RFCs that are used by existing clients.
37 cfe1893d 2002-05-08 alex 
38 194f18c8 2001-12-31 alex 
39 f39d6285 2003-01-04 alex III. Features (or: why use ngIRCd?)
40 f39d6285 2003-01-04 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41 194f18c8 2001-12-31 alex 
42 055d6e80 2016-01-06 alex - Well arranged (lean) configuration file.
43 055d6e80 2016-01-06 alex - Simple to build, install, configure, and maintain.
44 055d6e80 2016-01-06 alex - Supports IPv6 and SSL.
45 055d6e80 2016-01-06 alex - Can use PAM for user authentication.
46 055d6e80 2016-01-06 alex - Lots of popular user and channel modes are implemented.
47 055d6e80 2016-01-06 alex - Supports "cloaking" of users.
48 055d6e80 2016-01-06 alex - No problems with servers that have dynamic IP addresses.
49 055d6e80 2016-01-06 alex - Freely available, modern, portable and tidy C source.
50 055d6e80 2016-01-06 alex - Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
51 eeccc193 2005-06-26 alex   IRIX, Linux, Mac OS X, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
52 e0f8ce09 2012-01-04 alex - ngIRCd is being actively developed since 2001.
53 194f18c8 2001-12-31 alex 
54 c11e5501 2002-05-18 alex 
55 f39d6285 2003-01-04 alex IV. Documentation
56 cfe1893d 2002-05-08 alex ~~~~~~~~~~~~~~~~~
57 408793c2 2002-01-29 alex 
58 93146b57 2003-03-04 alex More documentation can be found in the "doc/" directory and the homepage of
59 055d6e80 2016-01-06 alex ngIRCd: <http://ngircd.barton.de/>.
60 408793c2 2002-01-29 alex 
61 e7214c15 2002-03-03 alex 
62 f39d6285 2003-01-04 alex V. Download
63 f39d6285 2003-01-04 alex ~~~~~~~~~~~
64 e7214c15 2002-03-03 alex 
65 055d6e80 2016-01-06 alex The homepage of the ngIRCd is <http://ngircd.barton.de/>; you will find
66 b976ec03 2005-07-09 alex the newest information about the ngIRCd and the most recent ("stable")
67 b976ec03 2005-07-09 alex releases there.
68 e7214c15 2002-03-03 alex 
69 055d6e80 2016-01-06 alex Visit our source code repository at GitHub if you are interested in the
70 055d6e80 2016-01-06 alex latest development version: <https://github.com/ngircd/ngircd>.
71 e7214c15 2002-03-03 alex 
72 e7214c15 2002-03-03 alex 
73 055d6e80 2016-01-06 alex VI. Problems, Bugs, Patches
74 055d6e80 2016-01-06 alex ~~~~~~~~~~~~~~~~~~~~~~~~~~~
75 cfe1893d 2002-05-08 alex 
76 055d6e80 2016-01-06 alex Please don't hesitate to contact us if you encounter problems:
77 cfe1893d 2002-05-08 alex 
78 055d6e80 2016-01-06 alex - On IRC: <irc://irc.barton.de/ngircd>
79 055d6e80 2016-01-06 alex - Via the mailing list: <ngircd-ml@ngircd.barton.de>
80 cfe1893d 2002-05-08 alex 
81 055d6e80 2016-01-06 alex See <http://ngircd.barton.de/support.php> for details.
82 055d6e80 2016-01-06 alex 
83 055d6e80 2016-01-06 alex If you find bugs in ngIRCd (which will be there most probably ...), please
84 055d6e80 2016-01-06 alex report them to our issue tracker at GitHub:
85 055d6e80 2016-01-06 alex 
86 055d6e80 2016-01-06 alex - Bug tracker: <https://github.com/ngircd/ngircd/issues>
87 055d6e80 2016-01-06 alex - Patches, "pull requests": <https://github.com/ngircd/ngircd/pulls>
88 055d6e80 2016-01-06 alex 
89 a84b9d99 2003-03-09 alex There you can read about known bugs and limitations, too.