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

Add WITH_BINDINGS to the install documentation

Browse Source
This commit is contained in:
Matt Williams 2012-06-21 22:48:54 +01:00
parent 42e2ebf734
commit bef1ae02ff
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
INSTALL.txt
View File

@ -16,6 +16,7 @@ With the following optional packages:
* ``qcollectiongenerator`` which comes with Qt Assistant is used for bundling the docs for installation * ``qcollectiongenerator`` which comes with Qt Assistant is used for bundling the docs for installation
* `Doxygen <http://doxygen.org>`_ for building the documentation. Version 1.5.7 is needed to build the Qt Assistant docs. 1.7.0 or greater is recommended * `Doxygen <http://doxygen.org>`_ for building the documentation. Version 1.5.7 is needed to build the Qt Assistant docs. 1.7.0 or greater is recommended
* `Python <http://python.org>`_, `Sphinx <http://sphinx.pocoo.org>`_ and `PyParsing <http://pyparsing.wikispaces.com/>`_ for generating the PolyVox manual in HTML * `Python <http://python.org>`_, `Sphinx <http://sphinx.pocoo.org>`_ and `PyParsing <http://pyparsing.wikispaces.com/>`_ for generating the PolyVox manual in HTML
* `Python development libraries <http://python.org>`_, `SWIG <http://swig.org/>`_ for generating the Python bindings
Linux Linux
===== =====
@ -47,6 +48,9 @@ The other available settings for PolyVox are:
``BUILD_TESTING`` (``ON`` or ``OFF``) ``BUILD_TESTING`` (``ON`` or ``OFF``)
Build the test applications that come with PolyVox. Running the tests is detailed in the next section. Defaults to ``ON``. Build the test applications that come with PolyVox. Running the tests is detailed in the next section. Defaults to ``ON``.
``WITH_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``.
``BUILD_STATIC_LIBRARIES`` and ``BUILD_DYNAMIC_LIBRARIES`` (``ON`` or ``OFF``) ``BUILD_STATIC_LIBRARIES`` and ``BUILD_DYNAMIC_LIBRARIES`` (``ON`` or ``OFF``)
Choose whether static (``.a``) or dynamic libraries (``.so``) should be built. On Linux both are built by default. Choose whether static (``.a``) or dynamic libraries (``.so``) should be built. On Linux both are built by default.