INSTALL

   1 luabind installation
   2 ====================
   3
   4 The build system used by luabind is Boost Build V2, which can be found
   5 at:
   6
   7   http://www.boost.org/doc/tools/build/index.html
   8
   9 The installation instructions are available at:
  10
  11   http://www.boost.org/doc/tools/build/doc/html/bbv2/installation.html
  12
  13 If you are using Debian or Ubuntu, you can simply install the
  14 "boost-build" package:
  15
  16   $ sudo apt-get install boost-build
  17
  18 Other distributions may have similar packages.
  19
  20 On Windows, you can download pre-built "bjam" binaries, and follow the
  21 installation instructions on the page linked above.
  22
  23
  24 Windows
  25 -------
  26
  27 The environment variable "BOOST_ROOT" must be set to the directory where Boost
  28 was extracted. "LUA_PATH" must be set to a directory where Lua binaries and
  29 headers reside. The recommended way to get the Lua libraries is to download the
  30 "DLL and Includes" package from:
  31
  32   http://luabinaries.luaforge.net/download.html
  33
  34 With these enviroment variables properly set:
  35
  36   $ set BOOST_ROOT=...
  37   $ set LUA_PATH=...
  38   $ bjam stage
  39
  40 Will build the default library variants and place them in a directory called
  41 "stage". This can be controlled with the "--stagedir" option:
  42
  43   $ bjam --stagedir=libs stage
  44
  45 Would place the libraries in a "libs" directory.
  46
  47 Note that there is nothing magic going on here. If you don't want to
  48 build the libraries this way, or run the tests, there is nothing
  49 stopping you from using whatever build system you want. For example,
  50 simply dropping the source files in a Visual Studio project should just
  51 work. The only requirement is that "LUABIND_DYNAMIC_LINK" must be
  52 defined when building and linking to a shared library.
  53
  54 \*nix
  55 -----
  56
  57   $ bjam install
  58
  59 Will build and install the default library variants, and install them together
  60 with the header files to the default prefix, which is "/usr/local". The install
  61 prefix can be controlled with the "--prefix" option. For example:
  62
  63   $ bjam --prefix=/usr install
  64
  65 Will install to "/usr/lib" and "/usr/include".