From 948508982c4252691c0295c25f30b5938529d4fe Mon Sep 17 00:00:00 2001 From: Matt Williams Date: Thu, 27 May 2010 15:29:24 +0000 Subject: [PATCH] Update INSTALL.txt to detail requirements and remove references to optional C++0x mode. --- INSTALL.txt | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/INSTALL.txt b/INSTALL.txt index cca24565..1745b588 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -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:= cmake command (the ``:`` 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:= 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.