Updating documentation.

This commit is contained in:
David Williams
2016-01-30 23:23:42 +00:00
parent e0b00fc5ac
commit 5103563365
2 changed files with 6 additions and 1 deletions

View File

@ -2,6 +2,11 @@
Building PolyVox
****************
.. warning ::
Before reading this information, be aware that *you may not actually need to build PolyVox in order to use it*. PolyVox is a header-only library and in many cases it is sufficient to simply copy the ``include/PolyVox`` folder into your source tree. This folder contains all the PolyVox header files, and you can probably then include them directly with ``#include "PolyVox/SomeHeaderHere.h"`` without even needing to change your compiler search paths.
That said, you *will* need to read the instructions below if you want to build the examples, tests, bindings or documentation which may be helpful in getting you started with PolyVox.
Requirements
============