Debian package wip

[chiark-tcl.git] / debian / README

diff --git a/debian/README b/debian/README
new file mode 100644 (file)
index 0000000..e0fa3f2
--- /dev/null
+++ b/debian/README
@@ -0,0 +1,36 @@
+        chiark-tcl - some useful Tcl bindings
+        -------------------------------------
+
+This package contains, basically, shared libraries
+  chiark_tcl_<something>-1.so
+in /usr/lib.
+
+Each of these is a Tcl extension which can be loaded into a Tcl
+interpreter with
+  load chiark_tcl_<something>-1.so
+and then the new commands will immediately be available.
+
+The documentation for each extension is regrettably rather sketchy but
+the following information should be enough to get you started:
+
+  <something>.tct
+
+      This is the input file to the automatic Tcl<->C glue generator
+      used by all of the extensions provided in this package.  This
+      lists the commands and subcommands available.
+
+  <something>.[ch].txt
+
+      Some of the extensions have additional usage documentation in a
+      source code comment.  This comment has been mechanically
+      extracted from the source file for your comfort and convenience.
+
+To gain an understanding of the way the *.tct files work, take a
+look at adns.c.txt which describes the `adns' command provided by
+the adns binding.
+
+Note that the file /usr/lib/chiark_tcl-1.so is NOT an amalgam of all
+of the extensions.  It is a set of common routines which will be
+loaded automatically when required.  Each extension must be loaded
+explicitly with the Tcl `load' command to bring the additional
+commands into the Tcl command namespace.