[gnue] r9309 - in trunk/gnue-sample: . forms processes schema

[reinhard]

Author: reinhard
Date: 2007-01-13 16:05:06 -0600 (Sat, 13 Jan 2007)
New Revision: 9309

Added:
   trunk/gnue-sample/INSTALL
Modified:
   trunk/gnue-sample/README
   trunk/gnue-sample/forms/customers.gfd
   trunk/gnue-sample/forms/invoices.gfd
   trunk/gnue-sample/forms/items.gfd
   trunk/gnue-sample/processes/sample.gpd
   trunk/gnue-sample/schema/country.gsd
   trunk/gnue-sample/schema/customer.gsd
   trunk/gnue-sample/schema/invoice.gsd
   trunk/gnue-sample/schema/invoice_item.gsd
   trunk/gnue-sample/schema/item.gsd
Log:
Updated documentation for sample.


Added: trunk/gnue-sample/INSTALL
===================================================================
--- trunk/gnue-sample/INSTALL   2007-01-13 21:34:26 UTC (rev 9308)
+++ trunk/gnue-sample/INSTALL   2007-01-13 22:05:06 UTC (rev 9309)
@@ -0,0 +1,15 @@
+INSTALLATION INSTRUCTIONS
+-------------------------
+
+In order to use these samples, make sure to have the database set up.
+
+If you're running an SVN copy of GNUe, use the script
+  bin/setup-db-svn.sh   (for *nix and OS X)
+  bin/setup-db-svn.bat  (for windows)
+
+If you're running an installed version of GNUe, use
+  bin/setup-db.sh       (for *nix and OS X)
+  bin/setup-db.bat      (for windows)
+
+This setup script creates a new sqlite3 database named 'sample.db' in the
+current working directory.

Modified: trunk/gnue-sample/README
===================================================================
--- trunk/gnue-sample/README    2007-01-13 21:34:26 UTC (rev 9308)
+++ trunk/gnue-sample/README    2007-01-13 22:05:06 UTC (rev 9309)
@@ -1,29 +1,28 @@
+GNUe Sample: A two-tier sample application for the GNU Enterprise tools.
 
-This is a small sample application showing some ways of using GNUe
 
-
-INSTALLATION:
+Installation:
 -------------
 
-In order to use these samples make sure to have the database set up.
+Please refer to the file `INSTALL' for installation instructions.
 
-If you're running an SVN copy use the script
 
-  bin/setup-db-svn.sh   (for *nix and OS X)
-  bin/setup-db-svn.bat  (for windows)
+Usage:
+------
 
-If you're running an installed version of GNUe use
-  bin/setup-db.sh       (for *nix and OS X)
-  bin/setup-db.bat      (for windows)
+If you're running an SVN copy of GNUe, use the script
+  bin/run-svn.sh   (for *nix and OS X)
+  bin/run-svn.bat  (for windows) [missing]
 
-This setup script creates a new sqlite3 database named 'sample.db' in the
-current working directory.
+If you're running an installed version of GNUe, use
+  bin/run.sh       (for *nix and OS X)
+  bin/run.bat      (for windows) [missing]
 
 
-FORMS:
-------
+Advanced usage:
+---------------
 
-To start a form (i.e. customer.gfd) use the argument
+To start a single form (e.g. customer.gfd), use the argument
 --connection=etc/connections.conf to ensure GNUe is using the proper database
 connection
 
@@ -37,3 +36,10 @@
 
 Of course you could add the [sample] connection to your system's
 connections.conf in order to avoid adding the additional argument
+
+
+License
+-------
+GNU Enterprise is free software.  See the file `COPYING' for the terms and
+conditions for copying, distribution and modification.
+

Modified: trunk/gnue-sample/forms/customers.gfd
===================================================================
--- trunk/gnue-sample/forms/customers.gfd       2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/forms/customers.gfd       2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Customers
  

Modified: trunk/gnue-sample/forms/invoices.gfd
===================================================================
--- trunk/gnue-sample/forms/invoices.gfd        2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/forms/invoices.gfd        2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Invoices
  

Modified: trunk/gnue-sample/forms/items.gfd
===================================================================
--- trunk/gnue-sample/forms/items.gfd   2007-01-13 21:34:26 UTC (rev 9308)
+++ trunk/gnue-sample/forms/items.gfd   2007-01-13 22:05:06 UTC (rev 9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Items
 

Modified: trunk/gnue-sample/processes/sample.gpd
===================================================================
--- trunk/gnue-sample/processes/sample.gpd      2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/processes/sample.gpd      2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,5 +1,28 @@
 <?xml version="1.0"?>
 
+<!--
+  GNU Enterprise Sample Application - Process definition
+ 
+  Copyright 2001-2007 Free Software Foundation
+ 
+  This file is part of GNU Enterprise
+ 
+  GNU Enterprise is free software; you can redistribute it
+  and/or modify it under the terms of the GNU General Public
+  License as published by the Free Software Foundation; either
+  version 2, or (at your option) any later version.
+ 
+  GNU Enterprise is distributed in the hope that it will be
+  useful, but WITHOUT ANY WARRANTY; without even the implied
+  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+  PURPOSE. See the GNU General Public License for more details.
+ 
+  You should have received a copy of the GNU General Public
+  License along with program; see the file COPYING. If not,
+  write to the Free Software Foundation, Inc., 59 Temple Place
+  - Suite 330, Boston, MA 02111-1307, USA.
+-->
+
 <processes title="GNU Enterprise Example Application">
   <description>
     <![CDATA[

Modified: trunk/gnue-sample/schema/country.gsd
===================================================================
--- trunk/gnue-sample/schema/country.gsd        2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/schema/country.gsd        2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Database Schema - Country 
  

Modified: trunk/gnue-sample/schema/customer.gsd
===================================================================
--- trunk/gnue-sample/schema/customer.gsd       2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/schema/customer.gsd       2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Database Schema - Customer
  

Modified: trunk/gnue-sample/schema/invoice.gsd
===================================================================
--- trunk/gnue-sample/schema/invoice.gsd        2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/schema/invoice.gsd        2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Database Schema - Invoice
  

Modified: trunk/gnue-sample/schema/invoice_item.gsd
===================================================================
--- trunk/gnue-sample/schema/invoice_item.gsd   2007-01-13 21:34:26 UTC (rev 
9308)
+++ trunk/gnue-sample/schema/invoice_item.gsd   2007-01-13 22:05:06 UTC (rev 
9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Database Schema - Invoice item
  

Modified: trunk/gnue-sample/schema/item.gsd
===================================================================
--- trunk/gnue-sample/schema/item.gsd   2007-01-13 21:34:26 UTC (rev 9308)
+++ trunk/gnue-sample/schema/item.gsd   2007-01-13 22:05:06 UTC (rev 9309)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+
 <!--
   GNU Enterprise Sample Application - Database Schema - Item