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

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

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

Added Files:
	building.txt 
Log Message:
rebaked the build files to remove the unused wxluawrap.cpp file
started docs for building wxlua


--- NEW FILE: building.txt ---
wxLua/docs/build.txt

This document describes how to build wxLua for use as an interpreter of lua 
scripts and to embedding wxLua in a C++ project.

------------------------------------------------------------------------------
Building wxLua
------------------------------------------------------------------------------

wxLua can be compiled in any platform and by any compiler that is supported by 
wxWidgets.

What libraries need to get build?
  wxLua/modules/lua   - lua itself, see www.lua.org
  wxLua/modules/wxlua - the base wxlua package
  wxLua/modules/wxbind - the bindings of wxWidgets for use in lua scripts
  wxLua/modules/wxluadebug - helpful classes for debugging lua
  wxLua/modules/wxluasocket - socket classes to run a wxlua program in a 
                                separate process and communicate with the parent

How to build the wxLua libaries
  MSW - enter wxLua/build/msw and build everything using
    MS VC   : nmake -f makefile.vc
    GCC     : make -f makefile.gcc
    BORLAND : make -f makefile.bcc
        
  Linux - in root wxLua directory run
    $./configure --prefix=path/to/where/you/want/it/built
    $make
    
How to build the wxLua app, the wxLua IDE
  The app depends on the libaries from modules/lua, wxlua, wxbind, 
  wxluadebug, and wxluasocket. You must have previously built these.

  MSW - if and you've run make from wxLua/build/msw you already have it.
  You want to build/rebuild it then enter wxLua/apps/build/msw and use the 
  same commands for make as described for the libaries.
    
  Linux - type make in the wxLua/wxlua/src
   
------------------------------------------------------------------------------
Advanced building options
------------------------------------------------------------------------------

  These directions are for C++ developers who want to use wxLua as a scripting
language in their own project. This means that you can write scripts to make 
your code simpler, load and run files on the fly, and allow users to more 
easily customize your program with their own lua scripts.

  You will need the library from wxLua/modules/lua and wxlua at a minimum. With
these two libraries you have the ability to start an interpreter and run
straight lua code in it. 
  To get the ability to create wxWidgets objects and use the functionality of 
wxWidgets in lua you will also need to build and link to the library in 
modules/wxbind. The bindings in modules/wxbind contain nearly all of the 
classes and functions in wxWidgets. They also contain the appropriate 
wxUSE_XXX #if statements and platform dependent __WXMSW__ checks that 
wxWidgets uses in their headers to ensure that no matter what platform
or what type of build you use, the bindings will compile without error.
The functionality will obviously be limited to your current wxWidgets build
settings.
  In order to reduce the size of the wxWidgets bindings there is a file 
modules/wxbind/src/wxluasetup.h that can be edited to your liking. The header 
file contains a number of wxLUA_USE_XXX #defines that are fairly self 
explanitory. By setting some of them to 0 you can block out large chunks of 
the bindings. NOTE: If you edit the wxluasetup.h file in modules/wxbind/src 
directory you will affect which bindings will be available to apps/wxlua as 
well. 
  If you wish to use the build files for modlues/wxbind that exist in wxLua
for your own project along with your own wxluasetup.h you need to...