Installation instructions for GNU Enterprise Forms
==================================================


Requirements
------------

To install gnue-forms, you need at least the following prerequisites installed
on your system [Debian packages in brackets]:

* Python 2.3 or greater [python python-dev]

* Egenix MX DateTime tools for Python [python-egenix-mxdatetime]

* GNUe Common 0.6.8 or greater [gnue-common]

* at least one of the following database interfaces, depending on the database
  you want to use (unless you run gnue-forms in a three tier environment with
  gnue-appserver):
  - psycopg2 (preferred for PostgreSQL) [python-psycopg2]
  - psycopg (also possible for PostgreSQL) [python-psycopg]
  - pyPgSQL (also possible for PostgreSQL) [python-pgsql]
  - pygresql (also possible for PostgreSQL) [python-pygresql]
  - python-mysqldb (for MySQL) [python-mysqldb]
  - KInterbasDB (for Interbase/Firebird) [python-kinterbasdb]
  - MaxDB (for MaxDB) [python-maxdb]
  - PySQLite (for SQLite2) [python-sqlite]
  - PySQLite2 (for SQLite3) [python-pysqlite2]
  You can find more information about possible database backends on the web
  page http://www.gnuenterprise.org/tools/common/databases/.

* optionally, one of more of the following user interface libraries (the text
  based "curses" user interface is always available):
  - wxPython 2.6 or later [python-wxgtk2.6]
  - PyQt3 [python-qt3]

You also need either a database server (one of those supported by GNUe) or GNUe
AppServer running on the local or on a remote machine, and in case of a
database server, you need the corresponding database client software installed
on the local machine.  We very much recommend that you make sure that you can
access the database with the databases's normal client tools before you try to
install and run gnue-forms against a database server.


Installation
------------

* Make sure that you have write permission in the directory /usr/local and its
  subdirectories.

* From the shell prompt, change into the directory containing the file
  "setup.py" and type "./setup.py install".  If you have all prerequisites
  installed, the installation process should run without errors.  If any error
  occures although you have fulfilled all dependencies described above, this is
  probably a bug, either in the installation program or in the documentation.
  Please report it.