
--------------------------------------------------------------------
GPUBench Version 1.0
--------------------------------------------------------------------

GPUBench is a set of programs that allow you to inspect the
performance of your graphics board in great detail.  GPUBench tests
are designed to provide information relevant to developers of GPUGPU
applications.

Detailed information about GPUBench usage and the individual tests is
provided in HTML form in the /doc directory.  For additional
information about GPUBench, visit the project webpage at
http://gpubench.sourceforge.net


--------------------------------------------------------------------
System Requirements
-------------------------------------------------------------------

To build GPUBench, you will need to have an installation of Cygwin
with the standard dev tools and Perl on your system.  If you wish to
run the scripts that generate formatted GPUBench summary reports, you
will also need Imagemagick in order for the scripts to properly
generate graphs.  Commandline usage of GPUBench programs does not
require Imagemagick.


--------------------------------------------------------------------
Build instructions:
--------------------------------------------------------------------

After you have cygwin installed with all of the dev tools, you should
just be able to type 'make'.  This has currently only been tested
under Windows XP.  The build process currently uses Microsoft's C++
compiler, so we assume you have Visual Studio installed (ie you have
cl.exe in your path) for the Windows builds.  You may also need to
modify your environment variables as follows:

INCLUDE
 C:\Program Files\Microsoft Visual Studio .NET 2003\SDK\v1.1\include\;
 C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\include;
 C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\PlatformSDK\Include

LIB
 C:\Program Files\Microsoft Visual Studio .NET 2003\SDK\v1.1\Lib\;
 C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib;
 C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\PlatformSDK\Lib

PATH
 C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\bin;
 C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\IDE


--------------------------------------------------------------------
Getting Started: Generating GPUBench Reports
--------------------------------------------------------------------

To generate a web page summarizing the performance of your hardware,
run:

perl scripts/GPUBench.pl <output>

Where <output> is the directory you wish the HTML report page and
associated files to be placed in.  The script will run a series of
GPUBench tests, and generate an HTML file containing a graphical
summary of results.

Note that running all the benchmarks may take several minutes on
certain systems.  The benchmarks make total use of your system GPU,
the Windows GUI may be unresponsive while the tests are running.  To
get the most accurate results, we suggest that you do not try and use
your system while running the tests, since any mouse interaction is
likely to cause GUI events that consume GPU resources.


-----------------------------------------------------------------
Individual Test Documentation
-----------------------------------------------------------------

Detailed docmentation of GPUBench tests is available in the
/doc directory.

