# $Id: README 2 2006-09-16 00:29:01Z unicinfo $
# Copyright (c) 2004 Kurt M. Brown.
# This file is subject to the terms and conditions of the GNU General Public
# License. See the file COPYING for more details.

=== 1. Requirements. ===

GenDDL requires php 5 or greater.

=== 2. Introduction. ===

Writing DDL in SQL for a schema is not much fun. It is even less fun
when having to create DDL for multiple database types.

In Oracle, constraint names have 30 character length restriction, so, once
again, not much fun.

I know of other such projects, but they do not work with php or are
mostly intended to be used with a gui.

GenDDL is for for those who like to use a text editor (e.g., vi) to
create software for multiple databases. GenDDL makes creating and
naming constraints and data-typing easy.

=== 3. Use. ===

To use genddl.php, one must create a scalars.xml file that defines the
various datatypes you want and create one or more DDL files that
defines the schemas.

I have included an example project "kb" under test/ that should be
reviewed to really understand how to use genddl.php. It is a schema
for a non-existent knowledge-base application that I created just
to test and demonstrate GenDDL.