]> git.cworth.org Git - apitrace/blobdiff - INSTALL.markdown
Change microseconds to use the greek mu symbol.
[apitrace] / INSTALL.markdown
index e6cfb6116af5b0c2817ebbf491c56f372a371cfd..60b2b09cd5ff31c239bc6a6b90c14a2d6b5ba66c 100644 (file)
@@ -20,7 +20,7 @@ The GUI also dependends on:
 
 * QJSON version 0.5 or higher (tested with version 0.7.1, which is bundled)
 
 
 * QJSON version 0.5 or higher (tested with version 0.7.1, which is bundled)
 
-Qt and QJSON will be required if `-DENABLE_GUI=TRUE` is passed to `cmake`, and
+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.
 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.
@@ -43,25 +43,49 @@ Build as:
 You can also build the 32bit GL wrapper on 64bit distro with a multilib gcc by
 doing:
 
 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 -DENABLE_GUI=FALSE
+    cmake \
+        -DCMAKE_C_FLAGS=-m32 \
+        -DCMAKE_CXX_FLAGS=-m32 \
+        -DCMAKE_EXE_LINKER_FLAGS=-m32 \
+        -DENABLE_GUI=FALSE \
+        -H. -Bbuild32
     make -C build32 glxtrace
 
     make -C build32 glxtrace
 
+Android
+-------
+
+Additional requirements:
+
+* [Android NDK](http://developer.android.com/sdk/ndk/index.html)
+
+Build as:
+
+    export ANDROID_NDK=/path/to/your/ndk
+    cmake -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain/android.toolchain.cmake -DANDROID_API_LEVEL=9 -H. -Bbuild
+    make -C build
 
 Windows
 -------
 
 Additional requirements:
 
 
 Windows
 -------
 
 Additional requirements:
 
-* Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
+* For Direct3D 11.1 support:
+
+  * [Microsoft Visual Studio 11 Ultimate Beta](http://www.microsoft.com/download/en/details.aspx?id=27543)
+
+* Other:
+
+  * Microsoft Visual Studio (tested with 2010 version) or MinGW (tested with
+    mingw-w64's gcc version 4.6.2)
 
 
-* Microsoft DirectX SDK:
+  * [Microsoft DirectX SDK](http://msdn.microsoft.com/en-us/directx/aa937781):
 
 
-  * for D3D10 support the [latest](http://msdn.microsoft.com/en-us/directx/default.aspx) is
-    recommended.
+    * for D3D 10, 10.1, and 11 support the [June 2010 release](http://www.microsoft.com/en-us/download/details.aspx?id=6812) 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.
+    * for 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:
 
 
 To build with Visual Studio first invoke CMake GUI as:
 
@@ -74,14 +98,14 @@ not found automatically, you can manually specify the location of the
 dependencies from the CMake GUI.
 
 After you've successfully configured, you can start the build by opening the
 dependencies from the CMake GUI.
 
 After you've successfully configured, you can start the build by opening the
-generated `build\apitrace.sln` solution file, or invoking `cmake` as:
+generated `build\apitrace.sln` solution file, or invoking CMake as:
 
     cmake --build build --config MinSizeRel
 
 
     cmake --build build --config MinSizeRel
 
-The steps to build 64bit version are similar, but choosing _Visual Studio 9
-2008 Win64_ instead of _Visual Studio 9 2008_.
+The steps to build 64bit version are similar, but choosing _Visual Studio 10
+Win64_ instead of _Visual Studio 10_.
 
 
-It's also possible to instruct `cmake` build Windows binaries on Linux with
+It's also possible to instruct CMake build Windows binaries on Linux with
 [MinGW cross compilers](http://www.cmake.org/Wiki/CmakeMingw).
 
 
 [MinGW cross compilers](http://www.cmake.org/Wiki/CmakeMingw).