gnue/gnue-config README

[Neil Tiffin]

CVSROOT:        /home/cvs
Module name:    gnue
Changes by:     Neil Tiffin <address@hidden>    01/09/02 07:21:36

Modified files:
        gnue-config    : README 

Log message:
        Clarify descriptions of folders.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue-config/README.diff?cvsroot=OldCVS&tr1=1.5&tr2=1.6&r1=text&r2=text

Patches:
Index: gnue/gnue-config/README
diff -u gnue/gnue-config/README:1.5 gnue/gnue-config/README:1.6
--- gnue/gnue-config/README:1.5 Tue Jul 24 16:48:22 2001
+++ gnue/gnue-config/README     Sun Sep  2 07:21:36 2001
@@ -1,4 +1,4 @@
-# gnue-config/README
+# gnue/gnue-config/README - Describes the gnue-config dir structure.
 #                  
 # Copyright (C) 2001 Free Software Foundation, Inc.
 #
@@ -6,7 +6,7 @@
 #
 # This file originally written by Neil Tiffin (address@hidden).
 #
-# $Revision: 1.5 $ $Date: 2001/07/24 23:48:22 $ $Author: ntiffin $
+# $Id: README,v 1.6 2001/09/02 14:21:36 ntiffin Exp $
 #
 
 gnue-config Directory
@@ -19,24 +19,27 @@
 Directory Structure
 ===================
                    
-gnue-config/base/module-name - contains all of the module definitions for 
+gnue-config/"package-name"/"module-name" - generic format for packages.
+                   "package-name = the functional package (i.e. accounting,
+                   base, supply-chain, etc.)
+                   
+gnue-config/"template-name"/"module-name" - generic format for templates.
+
+For Example:
+
+gnue-config/base/"module-name" - contains all of the module definitions for 
                    the base gnue enterprise system.  This includes all
                    module definitions that are common to other packages.
                    
 gnue-config/base/package-doc - folder contains the docbook format
                    for the base package documentation.
 
-gnue-config/supply-chain/module-name - contains all of the module definitions
+gnue-config/supply-chain/"module-name" - contains all of the module definitions
                    that pertain to the supply chain package.              
 
 gnue-config/supply-chain/package-doc - folder contains the docbook format
                    for the supply chain package documentation.
 
-gnue-config/package-name/module-name - contains all of the module definitions
-                   that pertain to packages.
-                   
-gnue-config/template-name/module-name - contains the module definitions and
-                   extensions for the industry templates
                    
 Each module-name folder contains the following folders:
     reports - contains report definitions (.grd)
@@ -45,6 +48,6 @@
     defaults - sql or other initialization scripts etc.  Note that
                file types of .geas are almost SQL files, suitable for
                use in documentation.  If you you want real .sql files
-               to load an SQl database then run
+               to load an SQL database then run
                geas/tools/parse_load_sql.py to convert .geas to .sql
     doc - the module documention files in docbook format.