Copyright (c) 2006-2008 Advanced Micro Devices, Inc. All Rights Reserved.
This software is subject to the Apache v2.0 License.


/*****************************************************************************/ 
 *                                                                           *
 *  This file explains the build procedure and                               *
 *  usage of the FW UnitTest application                                     *
 *                                                                           *
 *  The following topics are covered:                                        *
 *                                                                           *
 *  1. Build Steps                                                           *
 *  2. Program Usage                                                         *
 *  3. Options                                                               *
 *  4. Examples                                                              *
 *                                                                           *
/*****************************************************************************/ 

1. Build Steps
--------------

Use one of the following sequences when building the project:

For Microsoft(R) Windows(R):

        1. Build framewave shared libraries first, so that the shared libraries are available at the default locations (For detailed explaination on building Framewave refer http://framewave.sourceforge.net)
        2. Open 'UnitTest.sln' 
        3. Select the project configuration as 'Debug'OR 'Release'
        4. Build the project
 
Note: To run the UnitTest in case of dynamic linking, set the environment variable 'PATH' to locate the FW dlls.  

For LINUX(R), Solaris(R)and Mac(R):

        1. Build framewave shared libraries first, so that the shared libraries are available at the default locations (For detailed explaination on building Framewave refer http://framewave.sourceforge.net)
        2. Edit the 'build.sh' in the UnitTest directory to change the FW_BIN_PATH and FW_INC_PATH to point to the FW libraries (provide the absolute path)
        3. The default script is written for csh and requires appropriate changes while running on other shells
        4. Run 'build.sh' 
 
Note: To run the UnitTest

        i)Set the LD_LIBRARY_PATH environment variable to locate the FW libraries on Linux(R) and Solaris(R)
        ii)Set the DYLD_LIBRARY_PATH environment variable to locate the FW libraries on Mac(R)  

2. Program Usage 
----------------

Use the following syntax to invoke the UnitTest:

        UnitTestApp [-log: <filename>] [-quiet] [-diag] [-noheader] [config: <filename>] [-r] <unit test library1> [<unit test library 2> ...]

3. Options
----------

The following options are available:

        -log: <filename>        Generates a report in comma separated format(CSV) and writes it to specified file.
        -noheader               Skips the header from the report (useful when appending the report to an existing file)
        -quite                  Suppresses diagnostic messages from the report (only test fail/pass results will be included)
        -r                      Recursively searches for unit test libraries
        -diag                   Displays additional diagnostic information such as current directory and command parameters passed to the tool.
        -config: <filename>     Provides various configurations for commonly used function objects (i.e. thread count, code path, alignment, etc.)

4. Examples 
-----------

        1)UnitTestApp.exe AddTests.dll
          Enumerates and executes all tests in AddTests.dll
        2)UnitTestApp.exe c:\somefolder\MultiplyTests.dll d:\otherfolder\DivisionTests.dll
          Enumerates and executes all tests in the two DLLs specified
        3)UnitTestApp.exe c:\testfolder\*.dll
          Enumerates and executes all tests in all DLLs in folder c:\testfolder
        4)UnitTestApp.exe c:\tests\chapter1\*.dll c:\test\chapter3\*.dll
          Enumerate and execute all tests in all DLLs in folders c:\test\chapter1 and c:\test\chapter3

=================================================
WEB RESOURCES

The FW home page URL is:

        http://framewave.sourceforge.net/

        Please visit this URL for news, code samples, documentation, FAQ, and more. 
        Updates are posted periodically.

The FW online documentation URL is:

        http://framewave.sourceforge.net/Manual/aa_000_frames.html

The FW online forum URL is:
                You can go to the forum from the home page: http://framewave.sourceforge.net/
                To directly access the forum use the following url: http://sourceforge.net/forum/?group_id=212624

    * Developers forum - This forum will be useful for all who develop or enhance the Framewave APIs.

    * Open Discussion forum - This forum will be useful for all who use or consume the Framewave library.

=======================================================================================================
Framewave is a trademark of The Framewave Group.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
Sun and Solaris are registered trademarks of Sun Microsystems, Inc.
Linux is a registered trademark of Linus Torvalds.
Apple and Mac OS are registered trademarks of Apple, Inc.

Copyright (c) 2006-2008 Advanced Micro Devices, Inc. All Rights Reserved.
This software is subject to the Apache v2.0 License.
