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

Minor tweaks to the INSTALL.txt

Browse Source
This commit is contained in:
Matt Williams 2010-07-14 13:52:59 +00:00
parent 3f4c90f7e1
commit a7944a7895
1 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
INSTALL.txt
View File

@ -12,7 +12,7 @@ To build PolyVox you need:
With the following optional packages: With the following optional packages:
* `Qt <http://qt.nokia.com>`_ for building the tests * `Qt <http://qt.nokia.com>`_ for building the tests and the example applications
* ``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>`_ and `Sphinx <http://sphinx.pocoo.org>`_ for generating the PolyVox manual in HTML * `Python <http://python.org>`_ and `Sphinx <http://sphinx.pocoo.org>`_ for generating the PolyVox manual in HTML
@ -20,7 +20,7 @@ With the following optional packages:
Linux Linux
===== =====
Navigate to the PolyVox source (the directory containing this file) directory with and then enter the build directory with:: Navigate to the PolyVox source directory (the directory containing ``INSTALL.txt`` etc.) with and then enter the build directory with::
cd build cd build
@ -41,26 +41,26 @@ You can set CMake variables by passing ``-D<variable>:<type>=<value>`` to the ``
The other available settings for PolyVox are: The other available settings for PolyVox are:
``ENABLE_EXAMPLES`` (ON or OFF) ``ENABLE_EXAMPLES`` (``ON`` or ``OFF``)
Build the example applications that come with PolyVox. Defaults to ON. Build the example applications that come with PolyVox. Defaults to ``ON``.
``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``.
``CMAKE_BUILD_TYPE`` (Debug, Release, RelWithDebInfo or MinSizeRel) ``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``. String option to set the type of build. This will automatically set some compilation flags such as the optimisation level or define ``NDEBUG``.
For development work against the library For development work against the library
Use Debug or RelWithDebInfo Use ``Debug`` or ``RelWithDebInfo``
For your final version For your final version
Use Release Use ``Release``
For building packages (e.g. for Linux distributions) For building packages (e.g. for Linux distributions)
Use RelWithDebInfo Use ``RelWithDebInfo``
Building Building and installing
-------- -----------------------
Once this has completed successfully, simply run:: Once this has completed successfully, simply run::
@ -100,13 +100,15 @@ As well as the API documentation, PolyVox also provides a user manual. This is w
and the HTML manual will be available at ``<build directory>/documentation/index.html``. and the HTML manual will be available at ``<build directory>/documentation/index.html``.
If you have Sphinx installed but you do not get the confirmation in the CMake output, you may need to set ``SPHINXBUILD_EXECUTABLE`` to the location of you ``sphinx-build`` executable. If you have Sphinx installed but you do not get the confirmation in the CMake output, you may need to set ``SPHINXBUILD_EXECUTABLE`` to the location of your ``sphinx-build`` executable.
If you do not have Python and Sphinx installed and do not want to install them then the manual is just plain text (``.rst`` files) which are readable in their plain form. If you do not have Python and Sphinx installed and do not want to install them then the manual is just plain text (``.rst`` files) which are readable in their plain form.
Windows Windows
======= =======
For information about the dependencies, CMake configuration variables and buildable targets look at the Linux build information in the section above.
CMake CMake
----- -----