r5248 - in trunk: gnue-appserver gnue-common gnue-dbtools gnue-designer gnue-forms gnue-integrator gnue-navigator gnue-packages gnue-phpforms gnue-pos gnue-reports gnue-samples

[jcater]

Author: jcater
Date: 2004-03-06 18:58:55 -0600 (Sat, 06 Mar 2004)
New Revision: 5248

Modified:
   trunk/gnue-appserver/README
   trunk/gnue-common/README
   trunk/gnue-dbtools/README
   trunk/gnue-designer/README
   trunk/gnue-forms/README
   trunk/gnue-integrator/README
   trunk/gnue-navigator/README
   trunk/gnue-packages/README
   trunk/gnue-phpforms/README
   trunk/gnue-pos/README
   trunk/gnue-reports/README
   trunk/gnue-samples/README
Log:
cleaned up/standardized format of README files

Modified: trunk/gnue-appserver/README
===================================================================
--- trunk/gnue-appserver/README 2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-appserver/README 2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,27 +1,35 @@
-The GNU Enterprise Application Server
-=====================================
+GNUe AppServer: A tool of the GNUe Project (www.gnue.org)
 
-The GNU Enterprise Application Server is the core of the n-tier variant of the
-GNU Enterprise system.
-To the front end (be it GNUe Forms, GNUe Reports or any other tool), it
-provides user-defineable business objects with arbitary fields and methods.
-While transforming access to those fields and methods into database
-communication and calling of scripts, it cares about stability, security,
-speed, and consistency.
+Introduction
+------------
 
+The GNU Enterprise Application Server (AppServer) is the core of the n-tier
+variant of the GNU Enterprise system. To the front end (be it GNUe Forms, GNUe
+Reports or any other tool), it provides user-defineable business objects with
+arbitary fields and methods. While transforming access to those fields and
+methods into database communication and calling of scripts, it cares about
+stability, security, speed, and consistency.
+
 The GNUe Appserver is still under heavy development and not ready to be used
-in production environments.  This is a preview release.
-Please refer to the file named `NEWS' to see which version you are looking at
-here, and what has changed since earlier versions.
+in production environments.  This is a preview release. Please refer to the
+file named `NEWS' to see which version you are looking at here, and what has
+changed since earlier versions.
 
+Installation
+------------
 To install GNUe Appserver on your system, follow the procedure described in the
 file `INSTALL'.
 
+Running AppServer
+-----------------
 The directory `samples' contains several files that help you to try out GNUe
 Appserver once you have installed it.  Please refer to the file `README' in
 that directory for details.
 
+Please send bug reports to address@hidden
+
+License
+-------
 GNU Enterprise is free software.  See the file `COPYING' for the terms and
 conditions for copying, distribution and modification.
 
-Please send bug reports to address@hidden

Modified: trunk/gnue-common/README
===================================================================
--- trunk/gnue-common/README    2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-common/README    2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,5 +1,26 @@
-This package must be installed in order for GNU Enterprise Forms 
-and the other python dependent parts of GNUe to work.  Please 
-see INSTALL for installation instructions.
+GNUe Common: A library of the GNUe Project (www.gnue.org)
 
-It contains shared files and images for GNUe apps.
+Introduction
+------------
+GNUe-Common is the basis for the GNUe tools, such as Forms,
+Reports, Application Server, and Designer.  It implements a
+database-abstraction layer that provides support for most major
+databases. A builtin XML-to-Object parser and Object-to-XML
+marshaller are used by Forms, Reports, and Designer to save
+and read Forms/Report definitions to and from an XML file.
+It also defines and implements an RPC abstraction layer that
+will allow server processes to define their public methods once
+and have them available to CORBA, XML-RPC, SOAP, and DCOM
+clients.
+
+This package must be installed in order for the GNUe python-based
+tools to work.
+
+Installation
+------------
+Please see INSTALL for installation instructions.
+
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-dbtools/README
===================================================================
--- trunk/gnue-dbtools/README   2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-dbtools/README   2004-03-07 00:58:55 UTC (rev 5248)
@@ -0,0 +1,18 @@
+GNUe DBTools: A tool of the GNUe Project (www.gnue.org)
+
+Introduction
+------------
+GNUe DBTools contains tools useful to relational database
+developers. It includes an SQL shell, much like PostgreSQL's
+psql, MySQL's mysql, or Oracle's sqlplus. It provides a
+consistent commandset across all supported backends. It also
+includes a basic data loader.
+
+Installation
+------------
+Please see INSTALL for installation instructions.
+
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-designer/README
===================================================================
--- trunk/gnue-designer/README  2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-designer/README  2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,26 +1,39 @@
-GNUe Designer is a tool used to visually design forms. Eventually, it
-will be expanded to include Reports, GEAS directives, et al.
+GNUe Designer: A tool of the GNUe Project (www.gnue.org)
 
-  ******************************************************
-  WARNING: GNUe Designer 0.1.0 is not perfect code.
-  Odds are, it will crash on you at some point (many
-  points?), so if using on production forms, work from
-  a copy and save often.  See BUGS for known issues.
-  ******************************************************
+Introduction
+------------
+GNUe Designer is the IDE for the GNUe tools. It allows you to
+visually layout your forms in a RAD-style environment. Designer
+has a builtin forms client, so you can quickly test your forms
+while still in Designer.  Designer also has support for form
+creation wizards... answer a few questions, attach your form
+to one or more database tables, select the fields to include,
+and, voila, a basic form is created. Basic support for schema
+creation is also included.
 
-This tool requires gnue-common and gnue-forms (with wxPython support)
-installations.  These can be downloaded from www.gnuenterprise.org.
+Requirements
+------------
+This tool requires GNUe Common and GNUe Forms (wxPython-version).
+These can be downloaded from <http://www.gnuenterprise.org/tools/>.
 Designer has no dependencies aside from the dependencies of these
 two packages.
 
-For installation instructions, see the INSTALL file.
+Installation
+------------
+Please see INSTALL for installation instructions.
 
-Compatibility:
+Compatability
+-------------
   GNUe Designer has been successfully used on
-    Debian GNU/Linux
-    FreeBSD 4.x/5.0
-    RedHat GNU/Linux
-    Solaris 2.5.1
-    Slackware 8/9
-    Windows 98/NT/XP
+    * Debian GNU/Linux
+    * FreeBSD 4.x/5.0
+    * RedHat GNU/Linux
+    * Solaris 2.5.1
+    * Slackware 8/9
+    * Windows 98/NT/XP
+    * Mac OSX
 
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-forms/README
===================================================================
--- trunk/gnue-forms/README     2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-forms/README     2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,6 +1,7 @@
-GNUe Forms
-==========
+GNUe Forms: A tool of the GNUe Project (www.gnue.org)
 
+Introduction
+------------
 GNUe Forms is a data-aware user-interface generator. In more specific terms,
 Forms, using a clean XML-based definition, can display the same functional user
 interface in various physical mediums, whether GUI, HTML, console, or via a
@@ -18,17 +19,16 @@
 and and native GTK2 user interfaces. Forms includes support for Python-based
 events or triggers, for real-time validation of user data.
 
-Forms will seemlessly work with GNUe App Server, GNUe Navigator, and GNUe 
Reports if
-they are present. However, as part of GNUe's modular framework, Forms does not
-require any other GNUe tools to function.
+Forms will seemlessly work with GNUe App Server, GNUe Navigator, and GNUe
+Reports if they are present. However, as part of GNUe's modular framework, 
Forms
+does not require any other GNUe tools to function.
 
 Forms is currently in use in several locations, including commercial,
 non-profit, and academic.
 
 
-COMPATABILITY
+Compatability
 -------------
-
 GNUe Forms has been successfully used on
   * Debian GNU/Linux
   * Gentoo GNU/Linux
@@ -42,17 +42,16 @@
 People wanting to use curses mode should read the
 notes at end of this file.
 
-INSTALLATION
+
+Installation
 ------------
-
 Linux/Unix/BSD Users should read INSTALL file
 
 Windows Users should read INSTALL.win32
 
 
-RUNNING SAMPLES
----------------
-
+Running GNUe Forms
+------------------
 If you installed then just call the program
 
    $ gnue-forms -u text|gui filename.gfd
@@ -71,8 +70,16 @@
   ex: psql
       \i scriptname.sql
 
+Installation
+------------
+Please see INSTALL for installation instructions.
 
-NOTES
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.
+
+Notes
 -----
 [1] SLOWER MACHINES
     If gnue-forms seg faults when you run it, try running with the -s option.
@@ -84,8 +91,6 @@
 
     Note: this has now been reported on some faster machines!
 
-
-
 [2] CURSES is not functional at this time.
 
     To avoid a few of the artifacts use

Modified: trunk/gnue-integrator/README
===================================================================
--- trunk/gnue-integrator/README        2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-integrator/README        2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,4 +1,17 @@
-This is GNUe Integrator, a means of integrating/merging/loading data from 
-disparate sources. 
+GNUe Navigator: A tool of the GNUe Project (www.gnue.org)
 
-Work has just begun on Integrator, so don't expect much at the moment. 
+Introduction
+------------
+GNUe Integrator provides a platform- and database-independent method to
+load/merge/integrate data from multiple sources.
+
+Work has just begun on Integrator, so don't expect much at the moment.
+
+Installation
+------------
+Please see INSTALL for installation instructions.
+
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-navigator/README
===================================================================
--- trunk/gnue-navigator/README 2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-navigator/README 2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,14 +1,23 @@
-GNUe Navigator is a navigation/menuing system for GNU Enterprise.
+GNUe Navigator: A tool of the GNUe Project (www.gnue.org)
 
+Introduction
+------------
+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 the
+GNUe Forms or GNUe Reports clients to run the actual forms and
+reports, so these corresponding tools must be installed.
 
-To install:
 
-  ./setup.py install
+Installation
+------------
+Please see INSTALL for installation instructions.
 
 
+Running Navigator
+-----------------
 To run:
 
-
   To run an interactive session, type:
 
     gnue-navigator [-u <gui|text|curses>] <processdefs.gpd>
@@ -19,3 +28,11 @@
     gnue-navigator <--install-kde-menu |
       --install-gnome-menu> <processdefs.gpd> [menu=<BaseMenu>]
 
+Installation
+------------
+Please see INSTALL for installation instructions.
+
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-packages/README
===================================================================
--- trunk/gnue-packages/README  2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-packages/README  2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,16 +1,11 @@
-# gnue/packages/README - Describes the packages dir structure.
-#
-# Copyright (C) 2001 Free Software Foundation, Inc.
-#
-# This file is part of GNU Enterprise.
-#
-# This file originally written by Neil Tiffin (address@hidden).
-#
-# $Id: README,v 1.9 2001/12/01 03:48:43 ntiffin Exp $
-#
+GNUe Packages: A repository for GNUe ERP packages
 
-packages Directory
-=====================
+Introduction
+------------
+A repository for GNUe ERP packages.
+
+packages/ Directory
+-------------------
 This directory contains the various files used to configure GNUe to
 perform as enterprise software.
 
@@ -21,7 +16,7 @@
 the file name to end with ".geas.py".
 
 Directory Structure
-===================
+-------------------
 
 packages/"package-name"/"module-name" - generic format for packages.
                    "package-name = the functional package (i.e. finance,

Modified: trunk/gnue-phpforms/README
===================================================================
--- trunk/gnue-phpforms/README  2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-phpforms/README  2004-03-07 00:58:55 UTC (rev 5248)
@@ -1,19 +1,22 @@
-GNU Enterprise Forms Client (PHP version)
-=========================================
+GNUe Forms/PHP: A tool of the GNUe Project (www.gnue.org)
 
+Introduction
+------------
 GNU Enterprise Forms Client (short: GNUe Forms) is the front end to the
 GNU Enterprise system. This PHP version offers a web front end.
 
+Please send bug reports to address@hidden
 
 Compatibility
 -------------
-  GNUe Forms has been successfully used on
+  GNUe Forms/PHP has been successfully used on
     Debian GNU/Linux
 
-To install GNUe Forms (PHP Version) on your system, follow the procedure
-described in the file `INSTALL'.
+Installation
+------------
+Please see INSTALL for installation instructions.
 
-GNU Enterprise is free software. See the file `COPYING' for the terms and
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
 conditions for copying, distribution and modification.
-
-Please send bug reports to address@hidden

Modified: trunk/gnue-pos/README
===================================================================
--- trunk/gnue-pos/README       2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-pos/README       2004-03-07 00:58:55 UTC (rev 5248)
@@ -3,6 +3,7 @@
 Introduction
 ------------
 GNUe-PoS is the Point of Sale register program for the GNUe system.
+It is designed to work with your existing schema.
 
 Requirements
 ------------
@@ -17,8 +18,12 @@
 It currently requires wxPython 2.4 or greater, so it will work on
 Win32, GTK (Linux/*BSD), and MacOSX.
 
-Goals
------
+Installation
+------------
+Please see INSTALL for installation instructions.
+
+Features
+--------
 Short-term Goals:
 
   Commission tracking
@@ -68,4 +73,7 @@
   * On Account
   * Check Guarantee
 
-
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-reports/README
===================================================================
--- trunk/gnue-reports/README   2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-reports/README   2004-03-07 00:58:55 UTC (rev 5248)
@@ -2,6 +2,15 @@
 
 Introduction
 ------------
+GNUe-Reports is a platform and output-independent reporting system. It reads an
+XML-based report definition and generates arbitrary XML output that can further
+be translated into any format for which there is an adapter. GNUe Reports
+currently has outputs for Text, HTML, Label Stock, and CSV -- with PDF,
+Postscript, and Gnumeric/Excel formats in the works. Reports can output 
directly
+to a file, as an email attachment, to a printer, or to a HylaFax server.
+
+Overview
+--------
 GNUe Reports is a data transformation and output tool. At its most basic
 level, GNUe Reports transforms database data into arbitrarily complex XML.
 This XML can then be transformed into whatever format desired.
@@ -51,6 +60,8 @@
 For installation and configuration instructions, please read the
 file INSTALL.
 
+Compatability
+-------------
 GNUe Reports is known to work on the following platforms:
   * Debian GNU/Linux 2.x/3.x
   * RedHat Linux 7.x
@@ -62,7 +73,7 @@
 these platforms (i.e., MacOS, MS-Windows, et al.) -- especially the
 LprCommand and similar options.
 
-
-For questions, use the mailing list at http://www.gnue.org/
-or visit us in IRC at irc.openprojects.net, channel #gnuenterprise
-
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.

Modified: trunk/gnue-samples/README
===================================================================
--- trunk/gnue-samples/README   2004-03-07 00:25:51 UTC (rev 5247)
+++ trunk/gnue-samples/README   2004-03-07 00:58:55 UTC (rev 5248)
@@ -2,5 +2,13 @@
 
 Introduction
 ------------
-This package contains samples that run using the GNUe tools.
+This package contains samples that run use the GNUe developer tools.
 
+Installation
+------------
+Please see INSTALL for installation instructions.
+
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.