summary refs log tree commit diff stats
path: root/plugins/tcl/README
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/tcl/README')
-rw-r--r--plugins/tcl/README55
1 files changed, 55 insertions, 0 deletions
diff --git a/plugins/tcl/README b/plugins/tcl/README
new file mode 100644
index 00000000..e46635ef
--- /dev/null
+++ b/plugins/tcl/README
@@ -0,0 +1,55 @@
+Please read this document before asking questions.
+
+(1) WHAT IS THE TCL PLUGIN?
+
+    The XChat Tcl Plugin adds the complete Tcl scripting language to the
+    XChat 1.9.x and 2.x IRC client.  The design philosophy behind the tcl
+    plugin was to give all the power of the C API. yet completely shield
+    the user from all the complexities of it.  It is lightly modeled after
+    after Xircon; an old windows TCL enabled client with a little bit of
+    eggdrop functionality to it.
+
+    Features:
+     * Uses the popular TCL scripting language.
+     * Familiar to eggdrop bot owners.
+     * Adds many new XChat specific commands to the Tcl language for 
+       handling of events, user commands, timers, etc. 
+     * It's actually documented! (Hey, what a concept!) 
+     * Works with XChat 1.9.x and 2.x. 
+     * Open source (GPL) 
+
+    The supplied documentation for Tcl Plugin commands can be 
+    found in doc/tclplugin.html
+    
+    For a comprehensive list of IRC server tokens, see
+    doc/tokens.txt
+
+
+(2) HOW TO GET TCL PLUGIN
+
+    You can always find the latest version of the Tcl Plugin at:
+
+       http://www.scriptkitties.com/tclplugin
+
+   You must also have Tcl 8.3 or higher installed on your system.
+
+     Tcl can be obtained from:
+
+       http://sourceforge.net/projects/tcl
+       http://tcl.activestate.com (pre-compiled binaries)
+
+     Tcl Man Pages
+
+       http://tcl.activestate.com/man/
+
+     Tcl Tutorials:
+
+       http://hegel.ittc.ukans.edu/topics/tcltk/tutorial-noplugin/
+       http://jan.netcomp.monash.edu.au/ProgrammingUnix/tcl/tcl_tut.html
+       http://users.belgacom.net/bruno.champagne/tcl.html
+
+
+(3) QUICK STARTUP
+
+    SEE 'INSTALL'
+