wxlua-commit

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

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

Modified Files:
	building.txt 
Log Message:
wxEVT_DEBUG_XXX -> wxEVT_WXLUA_DEBUG_XXX and export them for DLL
reorder libs for linking in wxluaedit
TRUE/FALSE -> true/false
EVENT_DEBUG_XXX and CMD_XXX -> wxLUA_EVENT_DEBUG_XXX wxLUA_CMD_XXX


Index: building.txt
===================================================================
RCS file: /cvsroot/wxlua/wxLua/docs/building.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** building.txt	23 Nov 2005 06:03:40 -0000	1.1
--- building.txt	1 Dec 2005 04:17:29 -0000	1.2
***************
*** 1,6 ****
  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.
  
  ------------------------------------------------------------------------------
--- 1,6 ----
  wxLua/docs/build.txt
  
! This document describes how to build wxLua for use as an interpreter of lua
! scripts and for embedding wxLua in a C++ project.
  
  ------------------------------------------------------------------------------
***************
*** 8,12 ****
  ------------------------------------------------------------------------------
  
! wxLua can be compiled in any platform and by any compiler that is supported by 
  wxWidgets.
  
--- 8,12 ----
  ------------------------------------------------------------------------------
  
! wxLua can be compiled in any platform and by any compiler that is supported by
  wxWidgets.
  
***************
*** 16,21 ****
    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
--- 16,21 ----
    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
***************
*** 24,42 ****
      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
--- 24,91 ----
      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
! 
!     Or use the Makefiles located in the src dirs of each directory. The
!     Makefiles in the src dirs use wx-config to get the settings so be sure that
!     it's in your path.
! 
  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
! 
! ------------------------------------------------------------------------------
! Command line switches for make
! ------------------------------------------------------------------------------
!    Please see the top of the makefile you're using for your compiler. For
! example, if you're using nmake.exe (MS Visual C make program) look at
! makefile.vc. At the top you'll see this
! 
! In modules/build/msw/makefile.vc
! # C compiler
! CC = cl
! # C++ compiler
! CXX = cl
! # Standard flags for CC
! CFLAGS =
! # Standard flags for C++
! CXXFLAGS =
! # Standard preprocessor flags (common for CC and CXX)
! CPPFLAGS =
! # Standard linker flags
! LDFLAGS =
! # The directory where wxWidgets library is installed
! WX_DIR = $(WXWIN)
! # Use DLL build of wx library to use? [0,1]
! WX_SHARED = 0
! # Compile Unicode build of wxWidgets? [0,1]
! WX_UNICODE = 0
! # Use debug build of wxWidgets (define __WXDEBUG__)? [0,1]
! WX_DEBUG = 1
! # Version of the wx library to build against.
! WX_VERSION = 26
! 
! In apps/build/msw/makefile.vc
! # Compile the wxLua app ? [0,1]
! USE_WXLUAAPP = 1
! # Compile the wxLuaEditor app ? [0,1]
! USE_WXLUAEDITAPP = 0
! 
! To change the build settings to match those of your compiled wxWidgets library
! run nmake.exe in wxLua/build/msw as follows (but with your settings):
! 
! >nmake.exe WX_DEBUG=1 USE_WXLUAAPP=1 -f makefile.vc
! 
! and all of the appropriate wxLua libs will be compiled and in the case of
! USE_WXLUAAPP=1 the wxLua program in wxLua/apps/wxlua will be compiled too.
! 
  ------------------------------------------------------------------------------
  Advanced building options
***************
*** 44,75 ****
  
    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...
  
! 
! 
! 
! 
--- 93,128 ----
  
    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/GTK/MAC__ 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. If they don't compile for your settings, please be sure to tell us
! on the wxlua-users mailing list on SourceForge.
!   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...
  
! Linking Order:
!    The order in which you link to the wxLua libraries is important since some
! variable are initialized using variables from other libraries. You must always
! link to any binding library after you link to wxlua.
!    The library order in which they should be loaded; lua, wxlua, wxluadebug,
! wxluasocket, wxbind, any other bindings. Note that many linkers actually link
! them in the opposite order in which they appear on the command line.