SciTech SNAP Graphics DDK
                      Version 2.3 - Release 14

                       Getting Started Guide


What is this document for?
--------------------------

This text document is intended to be a brief overview to help
developers determine which files to download to get started.
However since the final documentation for the DDK has yet to be
written, this document will need to suffice to get you going.


What files to download?
-----------------------

In order to use the SciTech SNAP DDK, you must first have the
SciTech SNAP SDK installed and working. Since the SciTech SNAP
DDK shares the makefile and build system with the SDK, installing
the SDK first and getting familiar with the build process and
dmake will be very valuable when it comes to building the DDK.
Once you have the SDK set up, you can download the appropriate
source archive for the DDK depending on whether you want Unix
or DOS/Win32 format source files. Once you have downloaded the
source archive, uncompress all files into the directory on your
system where you want the DDK source files to live (normally
c:\private or ~/private for Unix). The names of the archives
included in this release are:

 snap_ddk_2.3-r14-src.zip        - Source archive in DOS/Win32 format

 snap_ddk_2.3-r14-src.tar.gz     - Source archive in Unix format

Please refer to the SciTech SNAP SDK documentation for details
on how to download and install the SDK. The full documentation
can be found on the web here:

 http://www.scitechsoft.com/docs/snap_ga


Open Watcom Compiler
--------------------

In order to build the SciTech SNAP DDK you will need a copy of
Open Watcom 1.2 or later (earlier versions will not work). The
1.2 release of Open Watcom contains native debugging support
for SciTech SNAP driver binaries, so you can build and debug
SNAP drivers with full source code using Watcom on supported
platforms. Presently this includes 32-bit DOS, OS/2 console
mode and Windows (Windows users can *only* use the DirectX
SNAP driver). A Linux version of the Open Watcom compiler is
under development and eventually you will be able to build
and debug SciTech SNAP drivers under Linux using Open Watcom.

At SciTech the most common scenario is to build everything
under either Windows 2000/XP or OS/2, and remote debug the
resulting binaries via TCP/IP or a laplink parallel cable
to OS/2 or 32-bit DOS. Contact SciTech for more information
on how to set up a DOS or OS/2 command prompt boot environment
similar to what we use to develop the driver binaries.


Building the DDK
----------------

Once the DDK source code is installed, you can build up debug
versions of the SciTech SNAP driver binaries from the
%PRIVATE%\src directory. If you go to that directory, you just need
to execute 'dmake' and dmake will go through the process of
building all the generic binary driver files in debug mode. The
main graphics.bpd binary will end up under %SCITECH%\drivers, and
the internal driver binaries modules will end up under
%SCITECH%\drivers\graphics. Once you have everything built up, you
should be able to compile any SciTech SNAP or MGL program (such as
GATest), and when the SciTech SNAP drivers are loaded, full source
debug info will show up under the Open Watcom debugger.


Connecting with Perforce
------------------------

All of the source code for the SciTech SNAP SDK and DDK is managed
by a public software repository, using the commercial Perforce version
management system. Perforce Software has graciously allowed Open Source
software projects to be able to use a free server license for that
source code.

If you wish to connect with Perforce, you can download a copy of the
entire public depot at the time the release was made. This contains a
lot more files than is distributed in the files listed above, but is
useful if you wish to avoid doing a large initial sync. You will need
one of the following files depending on the platform you are using, and
you will not need *any* of the files listed above:

 full_depot_r14.zip              - Complete copy of GPL depot in DOS/Win format
 full_depot_r14.tar.gz           - Complete copy of GPL depot in Unix format

For complete instruction on how to get connected via Perforce, please
refer to the full SNAP Graphics SDK documentation found here:

 http://www.scitechsoft.com/docs/snap_ga


---- END OF README-SDK.TXT ----