README

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