]> git.cworth.org Git - apitrace/commitdiff
Update instructions.
authorJosé Fonseca <jrfonseca@tungstengraphics.com>
Mon, 7 Jul 2008 14:47:42 +0000 (23:47 +0900)
committerJosé Fonseca <jrfonseca@tungstengraphics.com>
Mon, 7 Jul 2008 14:47:42 +0000 (23:47 +0900)
README

diff --git a/README b/README
index cbb04e4ec85f2eaaf39e2ab085c570ca8a393a65..c8b54f0c89531a4ef389efe0e40e59cac3963037 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,37 @@
+                                  D3D Trace
+
+
+= About =
+
 Wrapper DLLs to trace D3D8 and D3D9 APIs calls.
 
-Base on the idea and code (public domain) from Michael Koch. 
+Based on the idea and code (public domain) from Michael Koch. 
 
 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
+* 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
+
+
+= Status =
+
+* Only Direct3D 8 supported at the moment.
+
+
+= Build =
+
+* Install SCons and DirectX SDK.
+* Run:
+  scons
+
+
+= Usage =
+
+* Copy d3d8.dll, d3dtrace.xsl, d3dtrace.css 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.
 
 
 -- 
-Jose Fonseca <jrfonseca@tungstengraphics.com>
\ No newline at end of file
+Jose Fonseca <jrfonseca@tungstengraphics.com>