From 055d6e80561cc56fd2218c7698b3063931c8c17e Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Wed, 6 Jan 2016 19:01:25 +0100 Subject: [PATCH] Update README file --- README | 64 +++++++++++++++++++++++++++------------------------------- 1 file changed, 30 insertions(+), 34 deletions(-) diff --git a/README b/README index 5c8cc2c2..76971500 100644 --- a/README +++ b/README @@ -28,31 +28,26 @@ Please see the INSTALL document for installation and upgrade information! II. Status ~~~~~~~~~~~ +ngIRCd should be quite feature complete and stable to be used as daemon in +real world IRC networks. + 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. - -In the meantime ngIRCd should be quite feature complete and stable to be -used in real IRC networks. +specified by the RFCs that are used by existing clients. -Implemented IRC-commands are: - -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. @@ -61,33 +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: ). +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 have comments, patches or something else, please feel free to post -a mail to the ngIRCd mailing list: (please see - for details) or join the ngIRCd IRC -channel: . +If you find bugs in ngIRCd (which will be there most probably ...), please +report them to our issue tracker at GitHub: + +- Bug tracker: +- Patches, "pull requests": + +There you can read about known bugs and limitations, too. -- 2.39.2