X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=README;h=8fc78a1d6c9b167ccb5b84532b325eddc62bb867;hb=a263fc592702c2906232810a2aaa11075cfcb9fb;hp=c8b54f0c89531a4ef389efe0e40e59cac3963037;hpb=cabaafa1c8114c3c3f21978bc2a65fdb8b7c4c17;p=apitrace

diff --git a/README b/README
index c8b54f0..8fc78a1 100644
--- a/README
+++ b/README
@@ -1,37 +1,132 @@
-				   D3D Trace
+			      API Trace & Retrace
 
 
-= About =
+= Copyright =
+
+Copyright 2011 Jose Fonseca, Zack Rusin
+Copyright 2008-2010 VMware, Inc.
+All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 
-Wrapper DLLs to trace D3D8 and D3D9 APIs calls.
 
-Based on the idea and code (public domain) from Michael Koch. 
+= About =
 
-See also:
-* http://www.mikoweb.eu/index.php?node=21
-* http://www.codeguru.com/cpp/g-m/directx/directx8/article.php/c11453/
-* http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm
+This includes a set of tools for:
+- trace OpenGL, D3D8, and D3D9 APIs calls to a file;
+- retrace OpenGL calls from a file;
+- visualize trace files, and inspect state.
 
 
 = Status =
 
-* Only Direct3D 8 supported at the moment.
+* It has not been tested with many applications. Bugs in less used features may
+  cause application crashes.
+* Direct3D 8 support is currently broken.
+* No Direct3D retrace support
+
+
+= Building from source =
+
+Requirements common for all platforms:
+* Python (requires version 2.6)
+* CMake (tested with version 2.8)
+
+Requirements to build the GUI (optional):
+* Qt (tested with version 4.7)
+* QJSON (tested with version 0.7.1)
 
 
-= Build =
+== Linux ==
 
-* Install SCons and DirectX SDK.
-* Run:
-  scons
+Build as:
+
+ cmake -H. -Bbuild
+ make -C build
+
+
+== Windows ==
+
+Requirements:
+
+* Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
+
+* Microsoft DirectX SDK (tested with August 2007 release)
+
+To build with Visual Studio invoke CMake as:
+
+ cmake -G "Visual Studio 9 2008" -H. -Bbuild
+ cmake --build build --config MinSizeRel
+ 
+It's also possible to build on Linux with MinGW cross compilers.  See
+http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.
 
 
 = Usage =
 
-* Copy d3d8.dll, d3dtrace.xsl, d3dtrace.css to the directory with the application you want to trace.
+
+== Linux ==
+
+* Run the application you want to trace as
+
+ LD_PRELOAD=/path/to/glxtrace.so /path/to/application
+
+* View the trace with
+
+ /path/to/tracedump application.trace
+
+* Replay the trace with
+
+ /path/to/glretrace application.trace
+
+
+== Windows ==
+
+* Copy opengl32.dll, d3d8.dll, or d3d9.dll from build/wrappers directory to the
+  directory with the application you want to trace.
+
 * Run the application.
-* Open the output XML file with Firefox or Internet Explorer.
-* For long XML files is better to use the d3dtrace-txt.xsl stylesheet together with a dedicated XSL processor like xsltproc, or msxsl.
 
+* View the trace with
+
+ /path/to/tracedump application.trace
+
+* Replay the trace with
+
+ /path/to/glretrace application.trace
+
+
+= Links =
+
+* http://jrfonseca.blogspot.com/2008/07/tracing-d3d-applications.html
+
+
+== Direct3D ==
+
+ * [http://www.mikoweb.eu/index.php?node=21 Proxy DLL]
+   * [http://www.codeguru.com/cpp/g-m/directx/directx8/article.php/c11453/ Intercept Calls to DirectX with a Proxy DLL]
+ * [http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm D3DSpy]
+ * [http://msdn.microsoft.com/en-us/library/ee417062.aspx PIX]
+
+
+== OpenGL ==
 
--- 
-Jose Fonseca <jrfonseca@tungstengraphics.com>
+ * [http://www.opengl.org/sdk/tools/BuGLe/ BuGLe]
+ * [http://glintercept.nutty.org/ GLIntercept]
+ * [http://www.gremedy.com/products.php gDEBugger]