r4978 - in trunk: . gnue-common

[jcater]

Author: jcater
Date: 2003-12-17 20:46:02 -0600 (Wed, 17 Dec 2003)
New Revision: 4978

Added:
   trunk/README.txt
Removed:
   trunk/gnue-common/README-CVS
Log:
moved and updated README-CVS

Copied: trunk/README.txt (from rev 4977, trunk/gnue-common/README-CVS)
===================================================================
--- trunk/gnue-common/README-CVS        2003-12-18 02:40:49 UTC (rev 4977)
+++ trunk/README.txt    2003-12-18 02:46:02 UTC (rev 4978)
@@ -0,0 +1,163 @@
+
+Welcome to GNU Enterprise's Subversion Repository.
+
+
+GNU Enterprise is a set of tools used to implement enterprise-class
+data-aware applications.
+
+Subversion installation instructions are at the bottom of this document.
+
+
+DIRECTORY STRUCTURE
+-------------------
+
+NOTE: Each tool is maintained separately... some tools are further along than
+others.  Some tools are in use in production environments whereas others are
+still in a planning stage. Read each tool's README file for more details.
+
+
+gnue-forms/     
+           GNUe Forms is a data-aware user-interface generator. Using an XML-
+           based forms definition, GNUe Forms can present the user a
+           dynamically created "form" with fields bound to a database. With
+           a built-in trigger/events system, logic can be embedded in a form
+           to perform complex data verification/manipulation.
+
+gnue-reports/   
+           GNUe Reports is a reporting engine. With a complex Database-to-
+           XML mapping engine, Reports is designed to work with even the most
+           complicated reporting requirements. GNUe Reports provides both a
+           backend reporting server and various reporting clients.
+
+gnue-appserver/ 
+           GNUe App Server is a data and business rules server. It provides
+           an object-oriented backend to forms and reports. In an n-tier
+           environment, App Serverholds all business rules/logic and provides
+           object-to-relational access to various database backends.
+
+gnue-designer/  
+           GNUe Designer is an graphical IDE for GNU Enterprise.  Currently,
+           it only handles Forms Definitions, but support for Reports and
+           App Server class definitions are planned.  Designer requires the the
+           corresponding toolset for any definitions you plan to design. (i.e.,
+           GNUe Forms must be installed in order for designer to support Forms)
+
+gnue-navigator/ 
+           GNUe Navigator is a menuing system for GNUe Forms and Reports. It
+           presents a consistent menuing interface (in GUI or Text) based on
+           an XML "process definition."  GNUe Navigator uses GNUe Forms or
+           GNUe Reports to run the actual forms and reports, so these
+           corresponding tools must be installed (i.e., to run forms, GNUe
+           Forms must be installed.)
+
+gnue-integrator/ 
+           GNUe Integrator is a data migration/synchronization tool that can
+           be used to move or copy data from one datasource to another in a
+           batch-like mode. It is useful for pulling data from one production
+           database into another. 
+
+gnue-common/    
+           GNUe Common is required for any Python-based tools (GNUe Forms,
+           Reports, and Designer.) It defines a common code base for other
+           Python-based GNUe tools. GNUe-Common provides a consistent interface
+           to many databases and database middleware adapters.  See
+           common/README for more information and common/README.databases for a
+           list of supported database backends.
+
+gnue-packages/  
+           GNUe Packages is a set of definitions for geas that define various
+           business applications (e.g., finance, human resources, supply chain
+           management).  Each package is designed to work independently of
+           each other, but will also form a coherent system when installed
+           together.
+
+gnue-phpforms/  
+           GNUe Forms (PHP version) is a reimplementation of GNUe Forms in
+           PHP. It tries to provide a similar look and feel as GNUe Forms
+           through an web interface. See phpforms/README for more information.
+
+gnue-pos/  GNUe Point-of-Sale is a module-based register application. It 
+           is designed to be plugged into an existing architecture. For 
+           example, it can be customized to use your existing database 
+           structure.  It is in a very early stage of development, but is
+           used in at least two smaller retail establishments. 
+
+gnue-dbtools/
+           GNUe DBTools is a set of database data manipulation utilities
+           based off of GNUe-Common.  It provides a common set of command-
+           line utilities that can be used across several database vendors.
+           It includes a data loader and an interactive SQL shell. 
+
+
+The following directories contain no code and are basically support structures:
+
+docbook/   Various docbook-based documentation for GNU Enterprise. There's
+           plenty of goodies in this directory.
+
+samples/   Several sample programs that use the various GNUe tools. None of 
these
+           are actually meant for real-world use, but show off various features
+           of each tool.
+
+
+The various tools (Forms, Reports, App Server) can work independently of each
+other, or can work together to provide a complete enterprise application
+framework.
+
+The packages are designed to utilize all GNUe tools.
+
+
+BACKENDS
+--------
+
+Forms and Reports (both based on GNUe-Common) will work with or without App 
Server:
+
+ * With App Server
+
+    In this mode, an n-tier setup, App Server will contain all (most) business 
logic
+    and will provide objects to Forms and Reports.  App Server will perform 
object-
+    to-relational mapping between the database backends and the other tools.
+
+ * Without App Server 
+
+    In this mode, commonly a 2-tier setup, GNUe Forms/Reports will communicate
+    directly to a supported relational database or via a supported middle-ware
+    adapter, such as ODBC.  When using 2-tier mode, business rules must be
+    defined in the database or in the form or report definition (or both.)
+
+
+
+INSTALLATION
+------------
+
+There are two types of installations that can be performed from the Subversion 
tree:
+developer installation and production installation.  Note that each tool has
+its own set of dependencies.  It is recommended that you read the INSTALL file
+for each tool you plan to use to make sure your system has all the necessary
+prerequisites.
+
+
+ * Developer installation:
+
+  [ This option is only available on POSIX (Linux/Unix)
+    systems as it extensively makes use of symbolic links. ]
+
+
+  To install the python-based tools, type "python setup-cvs.py" from this
+  directory.  This will set up GNUe Common, GNUe Forms, GNUe Reports, 
+  GNUe Designer, GNUe Navigator, and GNUe App Server.
+
+
+ * Production Installation:
+
+  To install the python-based tools, go into each tool directory and run
+  'python setup.py install'.  If using Reports, Forms, or Designer, first
+  install the GNUe-Common libraries (in common/).
+
+
+ * Generating Snapshots:
+
+  To generate a snapshot, go into each tool directory and run
+  `GNUE_VERSION_SUFFIX=-`date +"%Y%m%d"` ./setup.py sdist'.  The resulting
+  file is placed in the `dist' subdirectory.
+
+

Deleted: trunk/gnue-common/README-CVS
===================================================================
--- trunk/gnue-common/README-CVS        2003-12-18 02:40:49 UTC (rev 4977)
+++ trunk/gnue-common/README-CVS        2003-12-18 02:46:02 UTC (rev 4978)
@@ -1,142 +0,0 @@
-
-Welcome to GNU Enterprise's Subversion Repository.
-
-
-GNU Enterprise is a set of tools used to implement enterprise-class
-data-aware applications.
-
-Subversion installation instructions are at the bottom of this document.
-
-
-DIRECTORY STRUCTURE
--------------------
-
-NOTE: Each tool is maintained separately... some tools are further along than
-others.  Some tools are in use in production environments whereas others are
-still in a planning stage. Read each tool's README file for more details.
-
-
-forms/     GNUe Forms is a data-aware user-interface generator. Using an XML-
-           based forms definition, GNUe Forms can present the user a
-           dynamically created "form" with fields bound to a database. With
-           a built-in trigger/events system, logic can be embedded in a form
-           to perform complex data verification/manipulation.
-
-reports/   GNUe Reports is a reporting engine. With a complex Database-to-
-           XML mapping engine, Reports is designed to work with even the most
-           complicated reporting requirements. GNUe Reports provides both a
-           backend reporting server and various reporting clients.
-
-appserver/ GNUe App Server is a data and business rules server. It provides
-           an object-oriented backend to forms and reports. In an n-tier
-           environment, App Serverholds all business rules/logic and provides
-           object-to-relational access to various database backends.
-
-designer/  GNUe Designer is an graphical IDE for GNU Enterprise.  Currently,
-           it only handles Forms Definitions, but support for Reports and
-           App Server class definitions are planned.  Designer requires the the
-           corresponding toolset for any definitions you plan to design. (i.e.,
-           GNUe Forms must be installed in order for designer to support Forms)
-
-navigator/ GNUe Navigator is a menuing system for GNUe Forms and Reports. It
-           presents a consistent menuing interface (in GUI or Text) based on
-           an XML "process definition."  GNUe Navigator uses GNUe Forms or
-           GNUe Reports to run the actual forms and reports, so these
-           corresponding tools must be installed (i.e., to run forms, GNUe
-           Forms must be installed.)
-
-integrator/ GNUe Integrator is a data migration/synchronization tool that can
-           be used to move or copy data from one datasource to another in a
-           batch-like mode. It is useful for pulling data from one production
-           database into another. 
-
-common/    GNUe Common is required for any Python-based tools (GNUe Forms,
-           Reports, and Designer.) It defines a common code base for other
-           Python-based GNUe tools. GNUe-Common provides a consistent interface
-           to many databases and database middleware adapters.  See
-           common/README for more information and common/README.databases for a
-           list of supported database backends.
-
-packages/  GNUe Packages is a set of definitions for geas that define various
-           business applications (e.g., finance, human resources, supply chain
-           management).  Each package is designed to work independently of
-           each other, but will also form a coherent system when installed
-           together.
-
-phpforms/  GNUe Forms (PHP version) is a reimplementation of GNUe Forms in
-           PHP. It tries to provide a similar look and feel as GNUe Forms
-           through an web interface. See phpforms/README for more information.
-
-
-The following directories contain no code and are basically support structures:
-
-docbook/   Various docbook-based documentation for GNU Enterprise. There's
-           plenty of goodies in this directory.
-
-samples/   Several sample programs that use the various GNUe tools. None of 
these
-           are actually meant for real-world use, but show off various features
-           of each tool.
-
-
-The various tools (Forms, Reports, App Server) can work independently of each
-other, or can work together to provide a complete enterprise application
-framework.
-
-The packages are designed to utilize all GNUe tools.
-
-
-BACKENDS
---------
-
-Forms and Reports (both based on GNUe-Common) will work with or without App 
Server:
-
- * With App Server
-
-    In this mode, an n-tier setup, App Server will contain all (most) business 
logic
-    and will provide objects to Forms and Reports.  App Server will perform 
object-
-    to-relational mapping between the database backends and the other tools.
-
- * Without App Server 
-
-    In this mode, commonly a 2-tier setup, GNUe Forms/Reports will communicate
-    directly to a supported relational database or via a supported middle-ware
-    adapter, such as ODBC.  When using 2-tier mode, business rules must be
-    defined in the database or in the form or report definition (or both.)
-
-
-
-INSTALLATION
-------------
-
-There are two types of installations that can be performed from the Subversion 
tree:
-developer installation and production installation.  Note that each tool has
-its own set of dependencies.  It is recommended that you read the INSTALL file
-for each tool you plan to use to make sure your system has all the necessary
-prerequisites.
-
-
- * Developer installation:
-
-  [ This option is only available on POSIX (Linux/Unix)
-    systems as it extensively makes use of symbolic links. ]
-
-
-  To install the python-based tools, type "python setup-cvs.py" from this
-  directory.  This will set up GNUe Common, GNUe Forms, GNUe Reports, 
-  GNUe Designer, GNUe Navigator, and GNUe App Server.
-
-
- * Production Installation:
-
-  To install the python-based tools, go into each tool directory and run
-  'python setup.py install'.  If using Reports, Forms, or Designer, first
-  install the GNUe-Common libraries (in common/).
-
-
- * Generating Snapshots:
-
-  To generate a snapshot, go into each tool directory and run
-  `GNUE_VERSION_SUFFIX=-`date +"%Y%m%d"` ./setup.py sdist'.  The resulting
-  file is placed in the `dist' subdirectory.
-
-