AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Update documentation for LIBRARY_TYPE

Browse Source
This commit is contained in:
Matt Williams 2012-07-19 17:36:01 +01:00
parent f11b4e17c1
commit ac7962b534
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
INSTALL.txt
View File

@ -51,8 +51,8 @@ The other available settings for PolyVox are:
``ENABLE_BINDINGS`` (``ON`` or ``OFF``)
Should the Python bindings to PolyVox be built. This requires the Python development libraries and SWIG to be installed. Defaults to ``ON``.
``ENABLE_STATIC_LIBRARIES`` and ``ENABLE_DYNAMIC_LIBRARIES`` (``ON`` or ``OFF``)
Choose whether static (``.a``) or dynamic libraries (``.so``) should be built. On Linux both are built by default.
``LIBRARY_TYPE`` (``DYNAMIC`` or ``STATIC``)
Choose whether static (``.a``) or dynamic libraries (``.so``) should be built. On Linux ``DYNAMIC`` is the default and on Windows ``STATIC`` is the default.
``CMAKE_BUILD_TYPE`` (``Debug``, ``Release``, ``RelWithDebInfo`` or ``MinSizeRel``)
String option to set the type of build. This will automatically set some compilation flags such as the optimisation level or define ``NDEBUG``.
@ -123,8 +123,6 @@ You need CMake installed so get the binary distribution from `CMake.org <http://
Point the source directory to the directory holding this file and the build directory to the ``build`` subdirectory. Then, click the ``Configure`` button. Click through the dialog box that appears and once you've clicked ``Finish`` you should see text appearing in the bottom text area. Once this has finished, some options will appear in the top area. The purpose of these options in detailed in the Linux→CMake section above. Once you have set these options to what you please, click ``Configure`` again. If it completes without errors then you can click ``Generate`` which will generate your compilers project files in the build directory.
Note that while on Linux it is possible to build both static and dynamic versions of the libraries, this is not possible on Windows. By default static libraries are built. If you want dynamic libraries (``.dll``) then make sure the ``ENABLE_STATIC_LIBRARIES`` option is disabled and the ``ENABLE_DYNAMIC_LIBRARIES`` option is enabled in the CMake GUI and reconfigure.
Building
--------