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

Update INSTALL.txt to detail requirements and remove references to

Browse Source 
optional C++0x mode.
This commit is contained in:
Matt Williams 2010-05-27 15:29:24 +00:00
parent 7a3f3b2b28
commit 948508982c
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
INSTALL.txt
View File

@ -2,6 +2,16 @@
Building PolyVox
****************
Requirements
============
To build PolyVox you need:
* CMake 2.6 or greater (http://cmake.org)
* A C++ compiler with support for some C++0x features (GCC 4.3 or VC 2010 seem to work)
* Qt for building the tests (optional)
* Docygen for building the documentation (optional)
Linux
=====
@ -18,7 +28,7 @@ Now, we use CMake to generate the makefiles with::
The ``..`` tells CMake to look in the parent directory for the source.
By default this will set it to be installed in ``/usr/local`` so if you want to install it elsewhere, set the ``CMAKE_INSTALL_PREFIX`` variable to the path you want to install to. If you are using a relatively modern compiler (GCC > 4.3 seems to do) you can also set ``ENABLE_CPP0X`` to build in C++0x mode rather than using the bundled Boost libraries.
By default this will set it to be installed in ``/usr/local`` so if you want to install it elsewhere, set the ``CMAKE_INSTALL_PREFIX`` variable to the path you want to install to.
You can set CMake variables by passing -D<variable>:<type>=<value> cmake command (the ``:<type>`` part is optional but recommended). For example, to set the install prefix, pass::
@ -26,9 +36,6 @@ You can set CMake variables by passing -D<variable>:<type>=<value> cmake command
The other available settings for PolyVox are:
``ENABLE_CPP0X`` (ON or OFF)
Build PolyVox using your compilers built-in versions of the C++0x features. Setting it to OFF will use the bundled Boost versions. Defaults to ON.
``ENABLE_EXAMPLES`` (ON or OFF)
Build the example applications that come with PolyVox. Defaults to ON.