X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=7697150092d55e78a4114d1e284130a9b3d45744;hp=36a77c064ac3baf8906b525db718b929d365b246;hb=055d6e80561cc56fd2218c7698b3063931c8c17e;hpb=22a9ed6694b50654592b8bd7e2ef4900f886e9e9 diff --git a/README b/README index 36a77c06..76971500 100644 --- a/README +++ b/README @@ -1,9 +1,8 @@ ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ - (c)2001-2007 Alexander Barton, - alex@barton.de, http://www.barton.de/ - + (c)2001-2016 Alexander Barton and Contributors. ngIRCd is free software and published under the terms of the GNU General Public License. @@ -13,11 +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 (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next -generation IRC daemon", 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,65 +28,62 @@ 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: - -ADMIN, AWAY, CHANINFO, CONNECT, DIE, DISCONNECT, ERROR, HELP, INVITE, ISON, -JOIN, KICK, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE, -OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, REHASH, RESTART, SERVER, SQUIT, -STATS, TIME, TOPIC, TRACE, USER, USERHOST, VERSION, WHO, WHOIS, WHOWAS. +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. III. Features (or: why use ngIRCd?) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- no problems with servers which have dynamic IP addresses -- simple, easy understandable configuration file, -- freely published open-source C source code, -- ngIRCd will be developed on in the future. -- 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. 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 "CVS" on the homepage and -the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent -Versioning System". +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 critics, patches or something else, please feel free to post a -mail to . +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": --- -$Id: README,v 1.24 2007/05/20 22:37:05 alex Exp $ +There you can read about known bugs and limitations, too.