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



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. GNADE and GPS
9. Additional Make Options
10. Contact



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, 2000, XP
- Solaris

for more information please refere to the release note of 
this release.
                        
4. Linux/Unix/Cygwin 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.

   In order to use the samples under ./samples you need
   to install the test database.

      gmake createdb

   This will install the tables and data of the test database
   in the database GNADE. Unter ./var you will find some sample
   ODBC init files which should work. For details please refer 
   to the documentation ODBC manager product you are using. 
   

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 DOS / Cygwin Installation
====================================

GNADE provides two basic build environments on the windows platform:

DOS - This is basically a batch driven build process which requires
      only the GNAT and ther GNAT-Win installation. The installer
      for windows provides an environment for DOS. 
GNU - This requires the installation of cygwin. The build works
      verry similar to linux.

There are two ways of obtaining the GNADE release. Either 
by downloading the setup.exe or by retrieving it from the 
CVS. 

** NOTE **
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.

6.1 Setup.exe
==============
The setup installer for windows is intended for the end user which
developes applications on top of GNADE and contains ready to use  
precomplied binaries and libraries campareable to the rpm packages 
for linux.
The setup includes the sources of the GNADE release as well, but only
of the software contained in the release. Normaly there is no need 
to install the sources. If you like to develop components for GNADE 
please use the CVS.

In order to use the following changes to the environment have 
to be done manually:

   PATH=%GNADE_BASEPATH%\bin:$PATH


6.2 GNADE CVS
==============
The CVS provides the current sources which need to be compiled before
they are usable for application development.

6.3 Compiling GNADE using DOS
=============================
In case that you have downloaded the code from the CVS at 
sourceforge then perform the following steps to compile 
the release:

    1. Edit make.conf.win32 to meet you system 
    2. cd <somewhere>\gnade
       configure 
       make

This should create directories win32-bin, win32-lib and 
win32-include with the GNADE libraries and packet 
specifications. In order to build an installer you need to 
have Inno-Setup installed. 

In order to build a setup.exe:

      make clean
      make dist

6.4 Building GNADE using Cygwin
===============================
If you have cygwin installed, basically the same procedures as for 
Linux/Unix do apply, which means:

   cd <somewhere>\gnade
   configure 
   make 

The only major difference is that you do not need to build an installer 
to install the software on your system. In order to install GNADE
run:

   make install

This installes all GNADE libraries, Ada Specs. etc. under /usr/local/gnade.
In order to make GNADE available, add to the PATH the path of GNADE:

   PATH=$PATH:/usr/local/gnade/bin

NOTE:

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

For windows the documenation is not yet part of the release
since i got no docbook working on the XP platform yet.

8. GNADE and GPS
================

GNADE is mainly based upon project files which can also be used 
by GPS (The GNAT Programing System www.act-europe.com). Each
subdirectory contains normaly one equally named project file.

If you are programming within the GNADE source tree do not try to change
the contents of the project file by means of the 
"Edit Project property" menu, because GPS will change the contents
of the project file in such a ways that the it is not possible
any more to compile the GNADE software. Two makefiles are included
in each directory:

	Makefile
	Makefile.<prj.name>

The Makefile.<prj name> is used by the GPS system. For some 
reason GPS sometimes calls directly gnatmake and under other 
circumstances the Makefile.<prj. name >.

GNADE provides a root project file which might be included to build
a project file for your application. If you wnat to do this, then
add to the project path the path of the GNADE project file as shown
below:

for Cygwin:
   ADA_PROJECT_PATH=...$ADA_PROJECT_PATH:$GNADE_BASEPATH/shared 

for Dos:
   ADA_PROJECT_PATH=%ADA_PROJECT_PATH%;%GNADE_BASEPATH%

9. Additional Make Options
==========================




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