Ignore assertion failure on Mac OS X.

[apitrace] / README

diff --git a/README b/README
index c62559d27060e3872c5c4b018ec3bdc7836a10fe..5e42178ff027a08f12a65d0f46420f05c774350a 100644 (file)
--- a/README
+++ b/README
@@ -1,47 +1,14 @@
                              API Trace & Retrace
 
 
-= 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.
-
-
 = About =
 
 This includes a set of tools for:
-- trace OpenGL, D3D8, and D3D9 APIs calls to a file;
+- trace OpenGL, D3D9, D3D8, D3D7, and DDRAW APIs calls to a file;
 - retrace OpenGL calls from a file;
 - visualize trace files, and inspect state.
 
 
-= Status =
-
-* 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:
@@ -53,7 +20,7 @@ Requirements to build the GUI (optional):
 * QJSON (tested with version 0.7.1)
 
 
-== Linux ==
+== Linux / Mac OS X ==
 
 Build as:
 
@@ -134,6 +101,22 @@ LD_LIBRARY_PATH:
   export TRACE_LIBGL=/path/to/real/libGL.so.1
   /path/to/application
 
+See the 'ld.so' man page for more information about LD_PRELOAD and
+LD_LIBRARY_PATH environment flags.
+
+
+== Mac OS X ==
+
+Usage on Mac OS X is similar to Linux above, except for the tracing procedure,
+which is instead:
+
+  DYLD_LIBRARY_PATH=/path/to/apitrace/wrappers /path/to/application
+
+Note that although Mac OS X has an LD_PRELOAD equivalent,
+DYLD_INSERT_LIBRARIES, it is mostly useless because it only works with
+DYLD_FORCE_FLAT_NAMESPACE=1 which breaks most applications.  See the 'dyld' man
+page for more details about these environment flags.
+
 
 == Windows ==