Index: README
===================================================================
RCS file: README
diff -N README
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ README	24 Mar 2005 22:36:34 -0000
@@ -0,0 +1,30 @@
+                        TclPro ByteCode Compiler
+                        ------------------------
+
+The compiler package transforms tcl scripts into an obfuscated bytecode
+representation suitable for distribution (e.g. when users need to be prevented
+from seeing and modifying script code).
+
+It is loaded with
+
+    package require compiler
+
+which defines two new commands 'compile' and 'getBytecodeExtension' in the
+compiler:: namespace.
+
+A script 'myscript.tcl' is compiled with
+
+    compiler::compile myscript.tcl
+
+the resulting bytecode is written out to file 'myscript.tbc'.
+
+A custom name for the output file can be specified as a second argument to the
+compile command:
+
+    compiler::compile myscript.tcl mybcscript.tbc
+
+Bytecompiled files are evaluated by sourcing (package tbcload has to be
+available)
+
+    source myscript.tbc
+