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



Contents
========
1. Introduction
2. License/Authors
3. Supported Platforms

4. Linux/Unix installation of the tar packages
   4.1 Installation of the GNADE environment
   4.2 Verification of the functionality
   4.3 Global installation of GNADE
   4.4 Test of the tar package installation

5. Linux/Unix installation of the RPM packges
6. Windows Installation
7. Documentation
8. Contact

Annex 1 . Build Production Reports


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

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).

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.

The projects provides additionaly native bindings
to PostgreSQL and MySQL.

Additionally the project provides an experimental 
interface called Ada Database Connectivity. Since this
interface is highly unstable no application code 
should be developed for this interface.

The project is available in tar and rpm format. The 
tar package contains the development environment
which has to build and installed on the target system.


The contents of your package is described in the 
release notes located under doc/releasenotes. 

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. Supported Platforms
======================
 
This software is known to operate on:
 
- Linux SuSe and Redhat distribution
- Windows NT
- Solaris

for more information please refere to the release note of 
this release.
                        
4. Linux/Unix Installation of the tar package
=============================================

The installation of the tar package is done in three steps:

 Step 1 - Installation of the development environment.
	  Building all libraries and executables of the 
          GNADE environment.

 Step 2 - Verification of the functionality

 Step 3 - Installation of the GNADE products globally.
 

4.1 Installation of the GNADE environment
=========================================

   After obtaining and unpacking the distribution into a 
   directory, perform the following step to create the 
   GNADE environment:

      cd ./gnade
      ./configure <options> <native bindings>

      Options :=  [-debug] 
		  [-assert] 
		  [--sampledb=<dbvendor>]

   Currently the dbvendor values postgres, mysql and
   mimer (for MimerSQL) are supported.

   Native bindings are available for mysql, postgres.

   All testprograms do require a small sample database. In 
   order to use the database you have to create a user for 
   your data base. Because this step has often to be done using
   a different user id and it is only done once you have
   to perform the following steps manualy:

      [ su db-adminstrator ]
      gmake createuser
      [ exit ]                                    

   After installing the data base user you may run the 
   global makefile by simply entering:

      gmake

   This will produce the libraries for the ODBC binding,
   the esql translator and a sample data base which is used
   by the examples under ./samples.

   The following directories will be created:

   autoconf		  - This directory contains all 
                            autoconf specific files.
   bin-linux-gnu-i486     - All binaries
   lib-linux-gnu-i486     - All libraries
   contrib                - Contributed code
   dbi                    - All data base interfaces (ODBC,MySQL
                            and PostgreSQL.
   doc			  - Toplevel directory for documentation and
                            release notes.
   esql			  - Source directory of the esql translator.
   samples	          - Top Level directory of all examples
   support		  - Contains support packages
   var                    - The place, where the data base space 
                            will be put (see MimerSQL)
   win32                  - Windows NT/2000 specific Makefiles                  

4.2 Verification of the functionality
=====================================

   Make process of the GNADE environment includes the 
   installation of a sample data base. The directory
   ./samples/smaple_db contains the installation procedure
   and the odbc.ini sample file. 

   The ./samples directory contains several samples
   which may be used to verify the correct operation
   of the GNADE environment. If all examples do work
   proceed with step 3.

4.3 Global installation of GNADE
================================

   In order to install the GNADE environment globally on your 
   system execute as root the following command:

      gmake install

   This will install the GNADE libraries and the esql translator
   in your system.

   /usr/local/lib/ada   - All library components
   /usr/bin             - Executable to esql.

   You may change these paths by modifying n the file etc/config.site
   the lines shown below:

	## all binaries (/usr/bin)
	site_bindir="/usr/bin"
	## all libraies  (/usr/lib)
	site_libdir="/usr/lib"
	## all compilation units (/usr/lib/ada/..)
	site_adadir="/usr/lib/ada"

   in the file ./make.conf.in before starting step 1.

4.4 Test of the tar package installation
========================================

The esql translator may be tested by changing into the 
directory ./samples/esql. The files with the extension
adq do contain Ada with embedded SQL code. The Makefile
builds the following executables:

./test_db  - A test file which shows some of the 
	     GNADE esql features.
./nobel_co - Reporting system for the nobel company


5. Installation of the RPM packages
===================================

There are two package for each version.

   gnade-<version>-<build>.src.rpm
   gnade-<version>-<build>.<arch>.rpm

To install the GNADE package execute the following command
as root:

   rpm -ivh  gnade-<version>-<build>.<arch>.rpm

If you like to have the source code install the first package
in the same way.

In order to test your installation copy the contents of 
/usr/share/doc/package/gnade/standalone into a directory
and compile the ada code. If the makefile completes sucessfully
the installation is ready.

PLEASE BE AWARE, THAT THE RPM PACKAGE DOES NOT CHECK YOU 
CONFIGURATION. THIS MEANS ODBC HAS TO BE INSTALLED PROPERLY.

6. Windows Installation
=======================

After obtaining and unpacking the distribution into a
directory, perform the following steps to create the
GNADE environment. This assumes GNAT is in your path.

      cd win32
      make

This builds the ODBC library in the directory
gnade/adaodbc. To use GNADE ODBC in your projects, add
gnade/adaodbc to the gnatmake search path.

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.


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

Documentation is available in pdf and html format. It is located in
the directory ./doc/html or ./doc. In particular, see the release
notes in doc/releasenotes.

The docbook sources of the documentation are locoated under 
./doc/build. If docbook is installed then you may build
the documentation by the command:

      gmake documentation


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://sourceforeg.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


Annex 1 - Build Production Reports
==================================

Below you find the latest test results with gnat 1.13p run
on the compile farm at sourceforge.net.

x86   - Linux 2.4 (Debian 2.2)              
	All Components are produced

x86   - Linux 2.4 (Redhat 7.0)
	All components are produced with 1.13p and 1.14

x86   - FreeBSD 	                    
	Configure is ok, complie could not be tested yet.

Alpha - Linux 2.2 (Debin 2.2)	            
	Configure is ok, complie could not be tested yet.

PPC   - RS/6000 Linux 2.4 (Debian 2.2)      
	Configure is ok, gnat failes with gigi error on odbc
	binding.

Sparc - Sparc Ultra 60 Linux 2.2
	Configure is ok, gnat failes with gigi error on odbc

Sparc - R220 / Solaris 2.8
	Configure is ok, gnat 1.14 failes with gigi error on
        odbc.

With GNAT 3.2:

x86   - Linux 2.2 (SuSe 8.1) and gnat 3.2
        Configure and compile ok but symbolic stack backtrace
	has been turned off since the addr2lines library is 
	not supported.