/*******************************************************************
 *                                                                 *
 *      PETE build and installation instructions for Windows       *
 *                           Version 2.0                           *
 *                                                                 *
 *******************************************************************
 *    For release notes, see README.TXT.                           *
 *    For licensing information, see LICENSE.TXT.                  *
 *    For the people who created PETE, see CREDITS.TXT.            *
 *    For a tutorial on using PETE, open html\index.html in your   *
 *        web browser.                                             *
 *    For more information, including updates and new releases,    *
 *        see http://www.acl.lanl.gov/pete                         *
 *    For help, reporting bugs, and making suggestions, please     *
 *        send e-mail to pete@acl.lanl.gov                         *
 *******************************************************************/

                      SUPPORTED COMPILERS:
                      --------------------

PETE version 2.0 has been ported to Windows 95/98/NT using the 
Metrowerks CodeWarrior Professional 4 compiler. About 5 MB of 
disk space is required if you build all of the supplied projects. 
32 MB of RAM will generally suffice. In future releases, we intend
to support the Intel VTune 3.0 C++ compiler running under Microsoft
Developer Studio. We don't believe that one can compile PETE
with Microsoft Visual C++ 5.0/6.0 due to the incomplete template
support. More information about Codewarrior and VTune 3.0 can be 
obtained from the URLs:

         Intel:                 http://www.intel.com
         Metrowerks:            http://www.metrowerks.com

                BEFORE YOU START TO COMPILE PETE:
                ---------------------------------

You should notice the following files/directories inside of the
pete-2.0 directory:

   CREDITS.TXT ................... the people who developed PETE
   examples\ ..................... sample PETE programs
   html\ ......................... HTML documentation for PETE
   ide\ .......................... project files for CodeWarrior
   INSTALL.TXT ................... this file
   LICENSE.TXT ................... the licensing terms for PETE
   README.TXT .................... general information and release notes
   src\ .......................... the PETE source code

(Optional)

Drag pete-2.0\ide\CodeWarrior\PETE\ folder to the 
Stationary folder, which is the the CodeWarrior distribution tree.
Drop this folder inside the Stationary folder. This will
enable you to make use of pre-built PETE prototype projects when
choosing "New Project..." from the File menu. Look inside of the Pooma
tab for the "Pete-Win" project type and select it. Note: these
prototype PETE projects assume you will be putting the folder containing
your new project in the same folder that contains pete-2.0.


              WINDOWS BUILD/INSTALL INSTRUCTIONS:
              -----------------------------------

PETE provides predefined Metrowerks CodeWarrior project files
inside of the folders:

  pete-2.0\ide\CodeWarrior\lib\examples\<example name>
  pete-2.0\ide\CodeWarrior\lib\src\Tools\
  
Many of the projects have both Macintosh and Windows targets. You can
actually cross-compile for Macintosh on your PC. There are many
projects that include optimized targets as well.

Note: If you did not install MacOS components, the IDE may complain about
not finding various MacOS access paths. This is harmless.

To run an example, simply choose Run or Debug (if
the debugger is enabled) from the Project menu. 

To make your own projects, copy one of the existing ones or, if you
installed the prototype projects as above use that. To make your
own classes PETE-aware, you'll need to build the MakeOperators tool.
To do this, double-click on the project file

  pete-2.0\ide\CodeWarrior\lib\src\Tools\MakeOperators.mcp
  
select the appropriate Win target, and choose 'Bring Up To Date' 
or 'Run...' from the Project menu.

To specify command line options select the project preferences 
menu item for your target and choose the Debugger -> Runtime Settings 
preference tab. There are two text boxes available: "Working Directory" 
and "Program Arguments". Type the approriate directory path and 
command line options in here. A typical command line is

--classes TArrayDefs.in --guard TARRAYOPS_H --o TArrayOperators.h

Open the file

pete-2.0\html\makeoperators.html

in your web browser for a detailed description of options.

Warning: To get really good performance out of expression-template-based code 
like PETE requires extremely aggressive inlining. The default optimization
options in the PETE CodeWarrior projects were chosen mainly to keep compile 
times fast since even the most aggressive compile options available to date
don't do enough. We are working with Metrowerks to improve this situation.
