--------------------------------------------------------------------------------
--
-- COPYRIGHT:
--   IBM WorkFrame - Project Smarts
--   (C) Copyright International Business Machines Corporation 1996
--   Licensed Material - Program-Property of IBM - All Rights Reserved.
--   US Government Users Restricted Rights - Use, duplication, or disclosure
--   restricted by GSA ADP Schedule Contract with IBM Corp.
--
--------------------------------------------------------------------------------

Project Smarts - Visual Builder README
======================================

The project is organized into the following hierarchy
which reflects the interdependencies between the projects:

        +-------------------------------------+
        |   Visual Builder Application        |
        |   (Builds the executable program)   |
        +-------------------------------------+
                        |
                        |
                        v
           +---------------------------+
           |     Help Project          |
           | (Builds the application's |
           |       help library)       |
           +---------------------------+


About this Project
__________________

Included with your Visual Builder project is a parts file called
$FILE_NAME:tolower$.vbb.  It contains a single part called 'WinMenu', that
consists of a frame window with a multi-cell canvas and few basic
push buttons, 'OK', 'Cancel', and 'Help'.

It also also contains a basic menu bar with some the standard CUA
pulldowns, 'File', 'Edit', 'View', and 'Help'.

The only controls that are connected are the 'Cancel' push button
and the 'Exit' menu item.

<if ($IPF$)>
There is also an IPF help source file $FILE_NAME:tolower$.ipf that
is created in a nested IPF Help project.
</if>
<if ($RTF$)>
There is also an RTF help source files, $FILE_NAME:tolower$.rtf and
$FILE_NAME:tolower$.hpj, in a nested RTF Help project.
</if>

Only the connected controls, the 'Cancel' push button and the 'Exit'
menu item have help.  There is also help for the entire window.

The Help subproject is set up to build the help library.  It is
built together with the main project.


Building the Project
____________________

To build the executable, you must first generate the source files
using the Visual Builder tool:

1. Select the $FILE_NAME:tolower$.vbb file in the project and select
   the 'Visual' menu item from its pop-up menu.  (Startup takes
   a few moments so please be patient).

   Two windows appear:
     - VisualAge for C++ Visual Builder
     - WinMenu - Composition Editor

2. To generate the source files, from the 'WinMenu - Composition Editor'
   window's 'File' menu:

     - Select 'Save and generate -> Part source' to generate the
       source for the Visual Builder part shown in the window.

     - Then select 'Save and generate -> Main for part' to generate the
       source for the program's 'main' function.

   The source code is now generated and ready to be compiled. The
   files are generated into the project's working directory.
   Select 'Refresh now' from the project's system menu to see them.

3. To build the VBMAIN.EXE executable program and the help library,
   select "Build Normal" from the Project menu.

