Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/data/tcl/irk/README @ 7484

Last change on this file since 7484 was 5781, checked in by rgrieder, 15 years ago

Reverted trunk again. We might want to find a way to delete these revisions again (x3n's changes are still available as diff in the commit mails).

  • Property svn:eol-style set to native
File size: 2.2 KB
Line 
1IRK README
2==========
3
4Welcome to IRK, a Tcl IRC client library. IRK is intended for Tcl
5programmers that want to use the IRC protocol for communication. It
6can be used to ease the creation of IRC "bots", as shown by the
7examples in the examples directory, and it can also serve as the basis
8for graphical chat clients. Finally, it can be used to allow IRKs to
9find each other without centralized coordination, by meeting on a
10designated IRC server and channel. It is therefore ideal for setting
11up the initial contact for P2P programs without requiring a central
12registry or server.
13
14LICENSE
15=======
16
17IRK is distributed under the BSD license, the same license as Tcl.
18
19INSTALLATION
20============
21
22IRK is written in pure Tcl, which means it requires no extensions. It
23works with Tcl 8.0 and all later releases of Tcl.
24
25IRK has been tested on Solaris 7, Red Hat Linux 7.2, Windows 98,
26Windows 2000 and FreeBSD 4.2. It should work on any platform that is
27able to support Tcl 8.0 or later.
28
29Just drop this directory into one of the directories in Tcl's auto
30path. In your Tcl scripts, add the line:
31
32        package require irk
33
34and the IRK package should load into your Tcl interpreter.
35
36USAGE
37=====
38
39Read docs/usage.txt for a short overview of the commands provided by
40IRK.
41
42RECENT CHANGES AND CURRENT VERSION
43==================================
44
45Please read docs/changes.txt to see a list of all changes, ordered
46chronologically by release.
47
48REQUIREMENTS
49============
50
51IRK is event driven, and it requires the event loop to be active. If
52you want to use IRK from tclsh or other programs embedding a Tcl
53interpreter where the event loop is inactive, enter the event loop by
54adding the following line somewhere in your program:
55
56        vwait infinitely
57
58If you are using IRK in Wish, you do not need to take any action.
59
60TODO
61====
62
63Please docs/todo.txt for a list of planned enhancements.
64
65CREDITS AND CONTACT
66===================
67
68IRK benefited from examination of the Zircon and savIRC code written
69by Lindsay Marshall and Saverio Castellano, respectively. The future
70OO wrapper API is based on an idea suggested by Dave N. Welton.
71
72You can contact Jacob Levy, the author of IRK, at jyl@best.com. Please
73do drop a note if you use IRK, or if you have suggestions for
74enhancements, or if you run into problems.
75
76
Note: See TracBrowser for help on using the repository browser.