=====================================
 Document-Version: v1.0 - 2006-07-28
=====================================


Introduction
============

Here is a simple description how this package allows you to create new WarpIN
packages and ZIP archives for PSI.



Directory structure
===================

  [...]
    +-- WarpIN                 <-- The stuff to create packages (*.cmd)
           +-- Build_Packages  <-- The created *.wpi, *.exe and *.zip go into                       
           |                       this directory.
           |                       e.g. PSI_0-10-0a1_os2_2006-07-25.wpi
           |
           +-- Scripts         <-- The *.wis (WarpIN) script for each Psi 
           |                       version is here.
           |                       e.g. psi_0-10-0a1.wis
           --- Version         <-- The Psi package for each Psi version is
                  |                stored here in a subdirectory 
                  |                e.g. psi_0-10-0a1.
                  + psi_0-10-0a1
                         |
                         + [files]



Filenames and Version
=====================

For Psi Version 0.10 I extended the version number to 0.10.0 because older
packages where named 0.9.1, 0.9.2 and so on and it's most likely that there
may be a revision number again in the future.

As you can see I didn't use '.' in the version number as eCS and OS/2 still
have problems (WarpIN packages are not recognized as WarpIN archive,...) if
there is more than one dot in the filename.

As dots are evil they are replaced by a minus character: major-minor-revision
Alpha versions get a 'a' and beta versions the 'b' and release-candidates
get 'rc' after the revision number followed by an increasing (build) number.
Final versions don't have the character.

Other elements in the filename are separated by '_' instead of spaces.
As additional element I added the operating system and the release-date
of the ported Psi version in the sortable 'YYYY-MM-DD' format.

So finally we get:
<APPNAME>_<MAJOR>-<MINOR>-<REVISION>[<'a'|'b'|'rc'><number>]_os2_<YYYY>-<MM>-<YY>.<'wpi'|'exe'|'zip'>



WarpIN installation script
==========================

The WarpIN script can be found in the scripts directory where
you need to add a new script for every version.
There are three things you need to look for, if a new package will be created:
 - Version number of the WarpIN script/package: "PACKAGEID="
   You have to update the version as described before:
    ..."\PSI Core Files\<MAJOR>\<MINOR>\<REVISION>[<'a'|'b'|'rc'><number>]
 - Version number and date information as text in the WarpIN *.wis file
   Look for the "YYYY-MM-DD" format and you should find them.
 - Changelog and Readme updates have to be updated in WarpIN "page" sections.



Creating new packages
=====================

In the WarpIN directory you will find two *.cmd files.

1.) If you don't have WarpIN in your "SET PATH" statement (which you normally
    don't have) you need to call the "warpin_env.cmd" script which should be
    able to get the WarpIN installation path from the OS/2 INI.
    If not you get an error message.

2.) You need to update the "create_psi_packages.cmd" with the WarpIN script
    version, the new path to the directory where build programm is and how
    the created package should be named.
    
3.) After you updated the "create_psi_packages.cmd" script you can call it.
    The created WarpIN packages (*.exe and *.wpi) and the created ZIP archive
    can be found in "Build_Packages".
    If there has been an error or you need to rebuild the packages you don't
    need to delete the files from the "Build_Packages" manually.
    This is done automatically. Logfiles for *.wpi and *.exe are created
    but you should still execute the packages manually.

4.) Distribute the files (*.wpi, *.exe, *.zip)! ;)



TODO
====

 - More REXX to automate creating WarpIN packages.
 - Add gcc*.dll + libc*.dll as additional package for installation
 - Automatic check if the packages and the ZIP archive is ok.


Contact
=======

Juergen Ulbts
E-Mail.: On request or see website
Website: http://www.juergen-ulbts.de/
ICQ....: 65814655 (Nick: magog96)
Jabber.: magog96@12jabber.com



Juergen Ulbts (2006-07-28)