            GNat Ada Database Environment (GNADE)
            ====================================
                  Revision : $Revision: 1.13 $



Contents
========
1. Introduction
2. License/Authors
3. Other supported Platforms
4. Software requirements
5. Integration with GPS
6. Compiling the release
7. Documentation
8. Contact
9. TODO

1. Introduction
===============

This is the Windows Release of GNADE. The GNADE projects 
provides tools and support packages in order to allow easy access to 
different data base systems using Ada 95 (specially the GNU Ada 95 
compiler GNAT).

The integration of SQL into Ada 95 is supported by an
embedded SQL translator which generates code working on
top of the GNADE ODBC bindings.

The GNADE ODBC bindings are a thin Ada 95 binding to ODBC 2.0.

The projects provides additionaly native bindings
to PostgreSQL, MySQL, Oracle and SQLite.

GNADE is delivered as an installer program or can be build from
sources using DOS or Cygwin (http://www.cygwin.com)

The windows installerd which provides the following installation 
components:

(1) Software Development Kit
(2) ODBC Tools
(3) Samples & Sample Database
(4) Source code
(5) Source code addons

The SDK contains everything to develop OBC and embedded SQL
based application. The SDK contents located in the subdirectories:

   win32-bin     : Binaries
   win32-lib     : Static libs of gnade
   win32-include : Package specifications
   win32-libexec : Tools localy used only from within GNADE
   win32-export  : Contains the installation targets (eg. the setup.exe)

The ODBC tools, located in win32-bin, are a set of small tools based 
on ODBC to import/export database contents. 

The samples and sample database is a single standalone example
how to use ODBC and embedded SQL. This component includes also
the scripts to create a test database.

The source code package contains the source code for this 
release. 

If you have Cygwin installed you can compile and install the release either
from CVS or downloading a source distribution from the project site. For 
building and installing GNADE with Cygwin please refere to the README 
related to Linux/Unix platforms.

2. License/Authors
==================

Generally speaking GNADE is an open source project.  For details 
please refer to the ./COPYING and ./AUTHORS files in this 
directory.

3. Other supported Platforms
============================
 
Beside of Windows, this software is known to work on:
 
- Linux SuSe, Redhat and Debian distribution
- Solaris

for more information please refere to the release note of 
this release.
                
4. Software Requirements        
========================

GNADE is expected to be used in combination with GNAT 3.15p.
Note that the Windows distribution of GNAT is in two parts; the
standard GNAT tools in gnat-3.15p-nt.exe and the extra Windows tools
and libraries in gnatwin-3.15p.exe. Both must be installed.

If GNADE is to be used as a development environment for applications
no additional tools are required.

If GNADE is to be rebuild and packaged for windows, the following tools 
are required:

- GNAT 3.15p (ftp://cs.nyu.edu)
- Inno Setup 4 (http://www.innosetup.com)

If you like to use the test database you need to install Mimer SQL 9.2
from http://www.mimer.com/.


5. Integration with GPS
=======================

If you are developing Ada 95 data base applications with GNAT you
may wish to use the GPS from http://www.act-europe.com which 
provides a resonable IDE for Ada 95 and the GNAT complier.

In order to do so, include always the project GNADE which 
provides the environment variables for the project file. Your 
project file needs to include the following line: 

with gnade
.....

Then you can use the environment variables as they are defined 
in the gnade.gpr file. The installer will provide a variable
called GNADE_PATH where gnade is installed. Add or extend  in your 
environment the following Variable as shown below:

ADA_PROJECT_PATH = ADA_PROJECT_PATH;%GNADE_BASEPATH%
Path = ....;%GNADE_BASEPATH%/bin

How to build an structure an poroject file please refere to the 
example located in %GNADE_BASEPATH%/standalone. 


6. Compiling the release
========================

There are two possible way of building the windows release. Either
you install cywin and build GNADE or you use the dos emnvironment
as it is delivered with Windows (XP).

After running the installer for windows, the source code will be 
installed under:
 
    c:\gnat\sources

There are two possible way of building the windows release. Either
you install cywin and build GNADE or you use the dos emnvironment
as it is delivered with Windows (XP). 

In both cases change into the installation directory of the sources
where the following steps have to be followed.

In case you are using DOS you need to edit the configuration 
file make.conf.win32. If you are using cygwin, this step needs
not to be done since confiugre does it automatically.

The source code may be recompiled at this place by performing the 
to steps:

    $ configure
    $ make

The compilation result will be stored in the same directory in the 
subdirectories:

    win32-bin
    win32-lib
    win32-include


If you have retrieved the software from the CVS the same procedure 
has to be followed:

    cd <somewhere>/gnade
    configure
    make 

The samples are not automaticall compiled and the test database 
is also not installed automatically. This has to be done manually
by means of the scripts located in gnade/samples/*.
    
The installation of the package is completly different for DOS and 
for Cygwin. 
In case of DOS a setup.exe is build which installs on window. If 
you you use Cygwin as a build environment then the installation needs
to be done manually.


7. Documentation
================

Currently the documentation is only available for Linux but it contains 
the Windows relevant parts as well (see http://gnade.sourceforge.net/)


8. Contact
==========

If you find an error or you need support, please 
use the facilities at:

   http://sourceforge.net/projects/gnade 


PLEASE FEEL FREE TO CONTRIBUTE TO THE PROJECT BY TESTING
AGAINST LEGACY CODE. PLEASE PROVIDE ME THE RESULTS OF YOUR
TESTS THAT I AM ABLE TO ADOPT THE ESQL TRANSLATOR TO YOUR 
REQUIREMENTS.

All official distributions will be stored  here as well.

In case you port the software to a different platform, 
please keep me informed either by sending me a mail

    Michael.Erdmann@snafu.de

or use the bug reporting facilities at:

    http://sourceforge.net/projects/gnade

A mailing list for GNADE related discussion has been 
established. In order do subscribe to the list goto:

    http://sourceforge.net/projects/gnade

9. TODO
=======

1. Configuration has to be made mutch simpler
2. Setup.exe has to check for SW dependencies, e.g. compiler 
   installed.
3. Installation of the test database should be part of the 
   setup.exe installer.
4. Documentation should be made available
5. Support components for GPS e.g. aliases etc are available 
   but not installed for GPS.


