[Wxlua-commit] wxLua/docs readme.txt,NONE,1.1

[John L. <jr...@us...>]

Update of /cvsroot/wxlua/wxLua/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19516/wxLua/docs

Added Files:
	readme.txt 
Log Message:
Removed the wxLuaInterpreter - all functions transferred to the wxLuaState
wxLuaInterpreter is typedefed to wxLuaState temporarily


--- NEW FILE: readme.txt ---
wxLua readme.txt

-------------------------------------------------------------------------------
wxLua is a lua scripting language wrapper around the wxWidgets cross-platform
GUI library. It consists of an executable for running standalone wxLua scripts
and a library for extending C++ programs with a fast, small, fully embeddable
scripting language.

References:
http://wxlua.sourceforge.net
http://www.lua.org
http://www.wxwidgets.org

-------------------------------------------------------------------------------
The wxLua "big picture"

Lua is an ANSI C compatible scripting language that can load and run
interpreted scripts as either files or strings. The language itself is very
dynamic and contains a limited number of data types, mainly numbers, strings,
and tables. Perhaps the most powerful feature of the lua language is that the
tables can be used as either arrays or as hashtables that can contain numbers,
strings, and or subtables.

wxLua adds to this small and elegant language the power of the wxWidgets
cross-platform GUI library. This incudes the ability to create complex user
interface dialogs, image manipulation, file manipulation, sockets, displaying
HTML, and printing.

-------------------------------------------------------------------------------
Brief description of the wxLua internals

The core of wxLua is based upon a ref counted class called wxLuaState derived
from the wxWidget's wxObject class. The wxLuaState class contains as a member
the 'C' lua_State which is the heart of lua. Since the class is ref counted,
it should be passed as const wxLuaState& and can be used in much the same way
as a wxBitmap, wxPen, or any of the other wxObject derived classes that make
use of it's ref counting.

The wxLuaState contains all of the lua 'C' functions, such as
lua_gettop(lua_State* L), but as member functions named lua_GetTop() which
use the internal lua_State and check for it's validity before use when compiled
in debug mode. The functions are capitalized to make them easier to find in an
editor. When the wxLuaState is Ok(), it means that the wxLuaState has
it's ref data and the lua_State is created.