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