Mention PIL requirement.

[apitrace] / INSTALL.markdown

diff --git a/INSTALL.markdown b/INSTALL.markdown
index b50fb7890721c5944bb030cfe3a58c2422eecce0..e6cfb6116af5b0c2817ebbf491c56f372a371cfd 100644 (file)
--- a/INSTALL.markdown
+++ b/INSTALL.markdown
@@ -2,17 +2,34 @@ Building from source
 ====================
 
 
+Requirements
+------------
+
 Requirements common for all platforms:
 
-* Python (requires version 2.6)
+* Python version 2.6 or 2.7
+
+  * Python Image Library
+
+* CMake version 2.8 or higher (tested with version 2.8)
+
+
+The GUI also dependends on:
 
-* CMake (tested with version 2.8)
+* Qt version 4.7
 
-Requirements to build the GUI (optional):
+* QJSON version 0.5 or higher (tested with version 0.7.1, which is bundled)
 
-* Qt (tested with version 4.7)
+Qt and QJSON will be required if `-DENABLE_GUI=TRUE` is passed to `cmake`, and
+never used if `-DENABLED_GUI=FALSE` is passed instead.  The implicit default is
+`-DENABLE_GUI=AUTO`, which will build the GUI if Qt is available, using the
+bundled QJSON if it is not found on the system.
 
-* QJSON (tested with version 0.7.1)
+
+The code also depends on zlib, libpng, and snappy libraries, but the bundled
+sources are always used regardless of system availability, to make the wrapper
+shared-objects/DLL self contained, and to prevent symbol collisions when
+tracing.
 
 
 Linux / Mac OS X
@@ -26,7 +43,7 @@ Build as:
 You can also build the 32bit GL wrapper on 64bit distro with a multilib gcc by
 doing:
 
-    cmake -H. -Bbuild32 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_EXE_LINKER_FLAGS=-m32
+    cmake -H. -Bbuild32 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_EXE_LINKER_FLAGS=-m32 -DENABLE_GUI=FALSE
     make -C build32 glxtrace
 
 
@@ -37,7 +54,14 @@ Additional requirements:
 
 * Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
 
-* Microsoft DirectX SDK (tested with August 2007 release)
+* Microsoft DirectX SDK:
+
+  * for D3D10 support the [latest](http://msdn.microsoft.com/en-us/directx/default.aspx) is
+    recommended.
+
+  * for DDRAW, D3D7, D3D8 support the [August 2007 release](http://www.microsoft.com/downloads/details.aspx?familyid=529F03BE-1339-48C4-BD5A-8506E5ACF571)
+    or earlier is required, as later releases do not include the necessary
+    headers.
 
 To build with Visual Studio first invoke CMake GUI as:
 
@@ -47,15 +71,9 @@ and press the _Configure_ button.
 
 It will try to detect most required/optional dependencies automatically.  When
 not found automatically, you can manually specify the location of the
-dependencies from the GUI.
-
-If you are building with GUI support (i.e, with QT and QJSON), it should detect
-the official QT sdk automatically, but you will need to build QJSON yourself
-and also set the `QJSON_INCLUDE_DIR` and `QJSON_LIBRARIES` variables in the
-generated `CMakeCache.txt` when building apitrace and repeat the above
-sequence.
+dependencies from the CMake GUI.
 
-After you've succesfully configured, you can start the build by opening the
+After you've successfully configured, you can start the build by opening the
 generated `build\apitrace.sln` solution file, or invoking `cmake` as:
 
     cmake --build build --config MinSizeRel