X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=45cabd691017039e49fcc7c21228b49005531a8b;hp=1ea96ef4157393dd717c4135ed1a3a67c2199067;hb=c37d6971d66a2d840a2b20fe2b995443c2bd6c87;hpb=e0f8ce093ad2cc389fe8ffd404addaf609451b3f diff --git a/README b/README index 1ea96ef4..45cabd69 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ ngIRCd - Next Generation IRC Server http://ngircd.barton.de/ - (c)2001-2012 Alexander Barton and Contributors. + (c)2001-2017 Alexander Barton and Contributors. ngIRCd is free software and published under the terms of the GNU General Public License. @@ -12,12 +12,15 @@ 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, see the file COPYING for details. ngIRCd means "next generation -IRC daemon" (which is a little bit exaggerated, "lightweight Internet Relay -Chat server" would be better), 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! @@ -25,31 +28,26 @@ Please see the INSTALL document for installation and upgrade information! II. Status ~~~~~~~~~~~ -It is not the goal of ngIRCd to implement all the nasty behaviours of the -original ircd, but to implement most of the useful commands and semantics -specified by the RFCs. - -In the meantime ngIRCd should be quite feature complete and stable to be -used in real IRC networks. +ngIRCd should be quite feature complete and stable to be used as daemon in +real world IRC networks. -Implemented IRC-commands are: +It is not the goal of ngIRCd to implement all the nasty behaviors of the +original ircd, but to implement most of the useful commands and semantics +specified by the RFCs that are used by existing clients. -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?) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 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, +- Well arranged (lean) configuration file. +- Simple to build, install, configure, and maintain. +- Supports IPv6 and SSL. +- Can use PAM for user authentication. +- Lots of popular user and channel modes are implemented. +- Supports "cloaking" of users. +- 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. - ngIRCd is being actively developed since 2001. @@ -58,32 +56,34 @@ IV. Documentation ~~~~~~~~~~~~~~~~~ More documentation can be found in the "doc/" directory and the homepage of -the ngIRCd: . +ngIRCd: . V. Download ~~~~~~~~~~~ -The homepage of the ngIRCd is: ; you will find +The homepage of the ngIRCd is ; 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 -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.or.cz/). +Visit our source code repository at GitHub if you are interested in the +latest development version: . -VI. Bugs -~~~~~~~~ +VI. Problems, Bugs, Patches +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you find bugs in the ngIRCd (which might be there :-), please report -them at the following URL: +Please don't hesitate to contact us if you encounter problems: - +- On IRC: +- Via the mailing list: -There you can read about known bugs and limitations, too. +See for details. + +If you find bugs in ngIRCd (which will be there most probably ...), please +report them to our issue tracker at GitHub: -If you have critics, patches or something else, please feel free to post a -mail to the ngIRCd mailing list: (please see - for details). +- Bug tracker: +- Patches, "pull requests": + +There you can read about known bugs and limitations, too.