Drop unused ReOpen method.

[apitrace] / README

diff --git a/README b/README
index 935ce60ca3ba30e0b6429ab9ca5bd9b142857f5a..a3fda3c958c5b53b75af8ac42d33ee7d1bce13b3 100644 (file)
--- a/README
+++ b/README
@@ -1,27 +1,33 @@
-                                  D3D Trace
+                                  API Trace
 
 
 = Copyright =
 
-Copyright 2008 Jose Fonseca, Tungsten Graphics, Inc.
+Copyright 2008-2009 VMware, Inc.
+All Rights Reserved.
 
-This program is free software: you can redistribute it and/or modify it
-under the terms of the GNU Lesser General Public License as published
-by the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+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:
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU Lesser General Public License for more details.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-You should have received a copy of the GNU Lesser General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+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.
 
 
 = About =
 
-Wrapper DLLs to trace D3D8 and D3D9 APIs calls.
+Wrapper DLLs to trace D3D8, D3D9, and OpenGL APIs calls.
 
 Based on the idea from Michael Koch. 
 
@@ -39,6 +45,9 @@ See also:
 
 = Building from source =
 
+
+== MSVC ==
+
 Requirements:
 * Python (tested with version 2.5)
 * SCons (tested with 0.98.4)
@@ -51,24 +60,24 @@ Instructions:
 
  scons debug=no dxsdk=C:\DXSDK
  
-* You can write those options to a file named config.py:
 
- # config.py
- debug=1
- dxsdk='C:\\DXSDK'
- 
-* Invoke
+== MinGW crosscompiler == 
+
+Requirements:
+* apt-get install mingw32
 
-  scons -h
+Intructions:
 
-See the scons manpage for more info.
+  scons platform=windows machine=x86 toolchain=crossmingw opengl32.dll
 
 
 = Usage =
 
-* Copy d3d8.dll/d3d9.dll, d3dtrace.xsl, d3dtrace.css to the directory with the application you want to trace.
+* Copy d3d8.dll, d3d9.dll, or opengl32.dll and apitrace.xsl to the directory with the application you want to trace.
 * Run the application.
-* Open the output XML file with Firefox or Internet Explorer to view the log.
-* For long XML files is better to use the d3dtrace-txt.xsl stylesheet together with a dedicated XSL processor like xsltproc, or msxsl.
+* Decompress the output .xml.gz and open the XML with Firefox or Internet Explorer to view the log. On Firefox hover on the arguments to see their contents.
+* For long XML files is better to use xml2txt.py script directly on the .xml.gz file, as:
 
+  python xml2txt.py d3d9.xml.gz > d3d9.log
 
+See also http://jrfonseca.blogspot.com/2008/07/tracing-d3d-applications.html