INSTALL

   1 Bullet Collision Detection and Physics Library
   2
   3 See also http://bulletphysics.org/mediawiki-1.5.8/index.php/Creating_a_project_from_scratch
   4
   5 ** Windows Compilation **
   6
   7         Open the Microsoft Visual Studio solution in msvc/20xx/BULLET_PHYSICS.sln
   8
   9 Alternatively, use CMake to autogenerate a build system for Windows:
  10
  11         - Download/install CMake from www.cmake.org or package manager
  12         - Use cmake-gui or
  13         - List available build systems by running 'cmake' in the Bullet root folder
  14         - Use cmake-gui
  15         - Create a build system using the -G option for example:
  16
  17         cmake . -G "Visual Studio 9 2008" or
  18         cmake . -G "Visual Studio 9 2008 Win64"
  19
  20
  21 ** Linux Compilation **
  22
  23   - Download/install CMake from www.cmake.org or package manager
  24     CMake is like autoconf in that it will create build scripts which are then
  25     used for the actual compilation
  26
  27         - List available build systems by running 'cmake' in the Bullet root folder
  28         - Create a build system using the -G option for example:
  29
  30         cmake . -G "Unix Makefiles"
  31
  32   - There are some options for cmake builds:
  33       BUILD_SHARED_LIBS: default 'OFF', set to 'ON' to build .so libraries
  34       BUILD_EXTRAS: default 'ON', compiles additional libraries in 'Extras'
  35       BUILD_DEMOS: default 'ON', compiles applications found in 'Demos'
  36       CMAKE_INSTALL_PREFIX: default '/usr/local', the installation path.
  37       CMAKE_INSTALL_RPATH: if you install outside a standard ld search path,
  38         then you should set this to the installation lib path.
  39       CMAKE_BUILD_TYPE: default 'Release', can include debug symbols with
  40         either 'Debug' or 'RelWithDebInfo'.
  41     Other options may be discovered by 'cmake --help-variable-list' and
  42     'cmake --help-variable OPTION'
  43
  44   - Run 'cmake' with desired options of the form -DOPTION=VALUE
  45     By default this will create the usual Makefile build system, but CMake can
  46     also produce Eclipse or KDevelop project files.  See 'cmake --help' to see
  47     what "generators" are available in your environment, selected via '-G'.
  48         For example:
  49         cmake -DBUILD_SHARED_LIBS=ON -DCMAKE_BUILD_TYPE=RelWithDebugInfo
  50
  51   - Assuming using the default Makefile output from cmake, run 'make' to
  52     build, and then 'make install' if you wish to install.
  53
  54
  55 ** Mac OS X Compilation **
  56
  57   - Download/install CMake from www.cmake.org or package manager
  58     CMake is like autoconf in that it will create build scripts which are then
  59     used for the actual compilation
  60
  61         - List available build systems by running 'cmake' in the Bullet root folder
  62         - Create a build system using the -G option for example:
  63
  64   cmake . -G Xcode
  65   cmake . -G "Unix Makefiles"
  66
  67   - There are some options for cmake builds:
  68       BUILD_SHARED_LIBS: default 'OFF', set to 'ON' to build .dylib libraries
  69       BUILD_EXTRAS: default 'ON', compiles additional libraries in 'Extras'
  70       BUILD_DEMOS: default 'ON', compiles applications found in 'Demos'
  71       CMAKE_INSTALL_PREFIX: default '/usr/local', the installation path.
  72       CMAKE_INSTALL_NAME_DIR: if you install outside a standard ld search
  73         path, then you should set this to the installation lib/framework path.
  74       CMAKE_OSX_ARCHITECTURES: defaults to the native architecture, but can be
  75         set to a semicolon separated list for fat binaries, e.g. ppc;i386;x86_64
  76       CMAKE_BUILD_TYPE: default 'Release', can include debug symbols with
  77         either 'Debug' or 'RelWithDebInfo'.
  78
  79     To build framework bundles:
  80       FRAMEWORK: default 'OFF', also requires 'BUILD_SHARED_LIBS' set ON
  81         If both FRAMEWORK and BUILD_SHARED_LIBS are set, will create
  82         OS X style Framework Bundles which can be placed in
  83         linked via the -framework gcc argument or drag into Xcode projects.
  84     (If not framework, then UNIX style 'include' and 'lib' will be produced)
  85
  86     Other options may be discovered by 'cmake --help-variable-list' and
  87     'cmake --help-variable OPTION'
  88
  89   - Run 'cmake' with desired options of the form -DOPTION=VALUE
  90     By default this will create the usual Makefile build system, but CMake can
  91     also produce Eclipse or KDevelop project files.  See 'cmake --help' to see
  92     what "generators" are available in your environment, selected via '-G'.
  93         For example:
  94         cmake -DBUILD_SHARED_LIBS=ON -DFRAMEWORK=ON \
  95               -DCMAKE_INSTALL_PREFIX=/Library/Frameworks \
  96               -DCMAKE_INSTALL_NAME_DIR=/Library/Frameworks \
  97               -DCMAKE_OSX_ARCHITECTURES='ppc;i386;x86_64' \
  98               -DCMAKE_BUILD_TYPE=RelWithDebugInfo
  99
 100   - Assuming using the default Makefile output from cmake, run 'make' to build
 101     and then 'make install'.
 102
 103
 104 ** Alternative Mac OS X and Linux via autoconf/make **
 105   - at the command line:
 106     ./autogen.sh
 107     ./configure
 108     make
 109
 110
 111 ** For more help, visit http://www.bulletphysics.org **