5ff22b796392753796312b3dab2e13b7ad649d71
[ngircd-alex.git] / doc / en / README
1                      ngIRCd - Next Generation IRC Server
2
3                       (c)2001,2002 by Alexander Barton,
4                     alex@barton.de, http://www.barton.de/
5
6                ngIRCd is free software and published under the
7                    terms of the GNU General Public License.
8
9                                 -- README --
10                            
11                       Ilja Osthoff, <ilja@glide.ath.cx>
12
13
14 I. Introduction
15 ~~~~~~~~~~~~~~~
16
17 ngIRCd is an Open-Source server for the Internet Realy Chat (IRC), which
18 is developped and published under the terms of the GNU General Public
19 Licence (URL: http://www.gnu.org/licenses/gpl.html). ngIRCd means "next
20 generation IRC daemon", it's written from scratch and not deduced from the
21 "grandfather of IRC daemons", the daemon of the IRCNet.
22
23
24
25 II. Status
26 ~~~~~~~~~~~
27
28 At present, the ngIRCd is under active development, some features are not
29 implemented, some only partly.
30
31 Till tody (more or less complete) implemented IRC-commands:
32
33 AWAY, DIE, ERROR, ISON, JOIN, KILL, LINKS, LIST, LUSERS, MODE, MOTD, NAMES,
34 NICK, NOTICE, NJOIN, OPER, PART, PASS, PING, PONG, PRIVMSG, QUIT, RESTART,
35 SERVER, SQUIT, TOPIC, USER, USERHOST, VERSION, WHO, WHOIS.
36
37
38 III. Features (or: why use ngIRCd?)
39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40
41 - no problems with servers which have dynamic ip-adresses
42 - simple, easy understandable configuration file,
43 - freely published C-Sourcecode,
44 - ngIRCd will be developed on in the future.
45 - supported platforms (tested versions): A/UX (3.0.1), FreeBSD (4.5), HP-UX
46   (10.20), Linux (2.4.x), Mac OS X, NetBSD (1.5.2), Solaris (2.5.1) and
47   Windows with Cygwin.
48
49
50 IV. Documentation
51 ~~~~~~~~~~~~~~~~~
52
53 English documentation:
54
55 - doc/en/README: the file that you are reading :-)
56 - doc/en/INSTALL: hints for the installation of the ngIRCd
57
58 German documentation:
59
60 - README: readme text in german
61 - INSTALL: german installation instructions
62 - NEWS: what do you think? :-) 
63 - Changelog: the complete history of the ngIRCd
64 - doc/FAQ.txt: frequently asked questions and answers
65 - doc/CVS.txt: hints for the CVS-system
66 - doc/RFC.txt: information about the RFC's
67 - doc/sample-ngircd.conf: sample configuration file
68 - doc/README-AUX.txt: installation hints for A/UX
69 - doc/README-BeOS.txt: the same for BeOS
70
71
72 V. Download
73 ~~~~~~~~~~~
74
75 The homepage of the ngIRCd is: <http://arthur.ath.cx/~alex/ngircd>; you
76 will find the newest information about the ngIRCd and the most recent
77 ("stable") releases there.
78
79 If you are interested in the newest developper-versions (which are not
80 always stable), then please read the section "CVS" on the homepage and
81 the file "doc/CVS.txt" which describes the use of CVS, the "Concurrent
82 Versioning System".
83
84
85 VI. Bugs
86 ~~~~~~~~
87
88 If you find bugs in the ngIRCd (which might be there :-), please report
89 them at the following URL:
90
91 <http://arthur.ath.cx/~alex/ngircd/#bugs>
92
93 There you can read about kown bugs, too.
94
95 If you have critics, patches or something else, please feel yourself free
96 to post a mail to: <alex@barton.de> or <alex@arthur.ath.cx>
97
98
99 -- 
100 $Id: README,v 1.3 2002/05/19 01:39:43 alex Exp $