This is tklua 4.0a1.

****** NOTE: Even if you are already an experienced tklua user, please
****** read the INSTALL file carefully before building the libraries
****** and the program. tklua 4.0 will not work without a patch to
****** tolua that fixes a critical bug.


* What is tklua?
  tklua allows programmers to access Tk widgets from Lua.
  You must have Tcl 8.0 and Tk 8.0 or later to use it.
  Besides all Tk widgets, it also offers the possibility of instantiating
  an OpenGL canvas, where users can draw images accessing the OpenGL functions,
  also from Lua.
  Programmers can use the Lua API to embed the library in their programs.
  So, one can write Lua scripts to build the interface and to bind users'
  actions, calling C/C++ functions if necessary.

* Availability
  tklua is freely available; you can redistribute it and/or modify it.
  The software provided hereunder is on an "as is" basis, and
  the author has no obligation to provide maintenance, support, 
  updates, enhancements, or modifications.

  tklua 4.0a1 can be downloaded from
            ftp://ftp.cis.upenn.edu/pub/cvogler/software/tklua.tar.gz   

  tklua 4.0a1 is a port of the tklua 2.1.2 code written by Waldemar Celes
  to the lua 4.0 API.
  tklua 2.1.2 can be downloaded from
            http://www.tecgraf.puc-rio.br/~celes/tklua/
            ftp://ftp.tecgraf.puc-rio.br/pub/celes/tklua/tklua.tar.gz

* Compatibility
  Lua scripts that were written for tklua 2.1.2 should work without
  modifications. If one of them breaks, this is most likely a bug in
  tklua. In this case, please let me know.

  Due to the API change in lua, the C library of tklua 4.0 is not
  backward-compatible with tklua 2.1.2. In general, all tklua functions
  now take a lua state as their first argument. 

  tkluaSetCurrent() is obsolete. tklua contexts are now associated with
  lua states. If you need multiple tklua contexts, create multiple lua
  states. If this change causes problems, please let me know, and I may
  revert it.

  lib/tkcompat.lua is deprecated and may disappear in the future.

* OpenGL embedding 
  It is still possible to embed an OpenGL canvas into a tklua application.
  However, as of 03/23/2001, the official port of gllua to the lua 4.0
  API is not complete yet. As a stopgap measure, an inofficial partial port
  of gllua (just libGL and selected parts of libGLU) is available at
            ftp://ftp.cis.upenn.edu/pub/cvogler/software/gllua.tar.gz 

  At this point, GL embedding has been tested only on Unix-based systems.
  The Windows-specific code may not even compile. I would be very
  interested in hearing success stories or receiving bug fixes from
  Windows users

* Installation
  See INSTALL.

* Bugs
  - Not all widgets and all code paths may have been tested thoroughly
  - tkgl.c is subject to change pending the official release of the port
    of gllua to the lua 4.0 API 
  - tkgl.c is untested on Windows and may not even compile
  - test/testgl.lua does not work with NVIDIA-GLX 0.9-769, whereas it
    works fine with Mesa and older versions of NVIDIA-GLX.

* Contacting the author
  tklua has been designed and implemented by Waldemar Celes.
  The port to the lua 4.0 API was done by Christian Vogler.

  Send your comments and bug reports about tklua 4.x to
  cvogler@gradient.cis.upenn.edu.

  The original author may be contacted at celes@tecgraf.puc-rio.br.
