$Header: /Users/cvs/dt/README.txt,v 1.2 2008/01/25 20:18:02 tberes Exp $

README FIRST



Licensing
--------------------------------------------------------------------------------------
This package (Dovetail Core Libraries and Frameworks) is licensed and copyrighted by
Dovetail Software, Inc. Portions of third party libraries have their own licensing
restrictions.

Copies of licenses can be found in the "src/licenses" folder, along with being
copied (e.g. built) to the output folder(s).

This software requires validily executed license agreements to be agreed upon by
the licensee/customer and Dovetail. Please see:

  "src/licenses/DovetailSourceCodeLicense.html"
  "src/licenses/Exhibit-A(sample).html"

A signed copy of the Exhibit A must be executed in order to use, examine
or otherwise possess this package.

Files and Directories
--------------------------------------------------------------------------------------
All files, with the exception of "deploy.properties" are version controlled using
CVS (see CVS section below for more information).

- README.txt           -- this file
- build.xml            -- build the various output artifacts
- src/                 -- source files
- deploy.properties    -- [NON CVS] override default build properties. Optional.
- staging              -- [NON CVS] build output root

Build Configuration
--------------------------------------------------------------------------------------

  Environment Settings
  ====================
  Set the following variables in your .bashrc or other startup profile script:

    DT_HOME=/Users/tim/Development/dt
    CATALINA_HOME=/usr/local/tomcat
    ANT_HOME=/usr/local/ant
    STRUTS_HOME=/usr/local/struts
    FMPP_HOME=/usr/local/fmpp
    JGROUSE_HOME=/usr/local/jGrouse
    JAVA_OPTS=-Xms384m -Xmx1400m
    JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/1.6/Home
    LANG=en_IE.UTF-8
    MYSQL_HOME=/usr/local/mysql
    PATH= {insure following in PATH: 
            $JAVA_HOME/bin:
            $JAVA_HOME/jre/bin:
            $MYSQL_HOME/bin:
            $ANT_HOME/bin:
            $CATALINA_HOME/bin}

  Tool and Framework Dependencies
  ================================
  0. Insure you have a functioning "cvs" program.
  1. Install Java 6 JDK or later.
  2. Install Ant 1.6 (1.7 preferred) or later.
  3. Install Struts 1.2.9.
  4. Install FMPP 0.9.11 or later.
  5. Install and configure MySQL 5.0 or later (5.1.xx preferred).
  6. Install jGrouseDoc 0.8.5 or later.
  7. Install and configure Tomcat 5.5.xx.

  Building the Software
  ================================
  $ cd $DT_HOME
  $ ant onetime            # one time setup; copies and configures ANT and checks env
  $ # next three targets typically invoked from an app build file
  $ ant build              # build output files
  $ ant jsdoc              # create Javascript documentation
  $ ant javadoc            # create Java documentation

END OF DOCUMENT