X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=README;h=7697150092d55e78a4114d1e284130a9b3d45744;hp=372498d8ef370059e39b3f087b196fe01e7680d7;hb=e84000f7b8b8fb8ae29f53f66dea488f904e0838;hpb=f39d6285125166aba022ef03249a94508bbddf33 diff --git a/README b/README index 372498d8..76971500 100644 --- a/README +++ b/README @@ -1,86 +1,89 @@ - ngIRCd - Next Generation IRC Server - (c)2001,2002 by Alexander Barton, - alex@barton.de, http://www.barton.de/ + ngIRCd - Next Generation IRC Server + http://ngircd.barton.de/ + (c)2001-2016 Alexander Barton and Contributors. ngIRCd is free software and published under the terms of the GNU General Public License. -- README -- - - Ilja Osthoff, I. Introduction ~~~~~~~~~~~~~~~ -ngIRCd is an Open-Source server for the Internet Realy Chat (IRC), which -is developped 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! II. Status ~~~~~~~~~~~ -At present, the ngIRCd is under active development, some features are not -implemented, some only partly. - -Till today (more or less complete) implemented IRC-commands: +ngIRCd should be quite feature complete and stable to be used as daemon in +real world IRC networks. -ADMIN, AWAY, CHANINFO, CONNECT, DIE, ERROR, INVITE, ISON, JOIN, KICK, KILL, -LINKS, LIST, LUSERS, MODE, MOTD, NAMES, NICK, NJOIN, NOTICE, OPER, PART, -PASS, PING, PONG, PRIVMSG, QUIT, RESTART, SERVER, SQUIT, TIME, TOPIC, -USERHOST, USER, VERSION, WHO, WHOIS. +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-adresses -- simple, easy understandable configuration file, -- freely published C-Sourcecode, -- ngIRCd will be developed on in the future. -- supported platforms (tested versions): AIX (3.2.5), A/UX (3.0.1), FreeBSD - (4.5), HP-UX (10.20), IRIX (6.5), Linux (2.x), Mac OS X (10.x), NetBSD - (1.5.2/i386, 1.5.3/m68k), Solaris (2.5.1, 2.6), and Windows with Cygwin. +- 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 (in english). Please -have a look at "doc/de/" if you are looking for german documentation. +More documentation can be found in the "doc/" directory and the homepage of +ngIRCd: . V. Download ~~~~~~~~~~~ -The homepage of the ngIRCd is: ; you -will find the newest information about the ngIRCd and the most recent -("stable") releases there. +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 newest developper-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 kown bugs, too. +See for details. -If you have critics, patches or something else, please feel yourself free -to post a mail to: or +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.15 2003/01/04 13:12:39 alex Exp $ +There you can read about known bugs and limitations, too.