


In this file all directories used by Ghun or planned to be used by GHUN
using tools are documented with the intended use and their status, e.g.
mandatory or optional.

In standard setups all directories mentioned are expected to be located
at the place described here. Some specific directories, e.g. the data
directory or the costumer specific lib directory, may be used at some
other location, but this has to be declared in file 'bin/base.rb'

- Top level directory
  The  expanded top level directory name is accessible as
  'top_level_path' in the blackboard (Ghun::Base::Blackboard)
 - src (application_path in blackboard
  - bin (binary_path)
  - config (config_path)
  - lib (library_path)
   - This directory is designed to contain a costumer specific lib dir,
     to separate propably confidential knowledge
  - test
  - tools
  - local (local_path)
   - config (local_config_path)
   - lib(local_libray_path)
   - doc (see non local description)
   - license (see non local description)
   -
   - This directory and its subdirectories MAY exist
   - This directory is designed to contain costumer specific files such
     as specific modules, classes or configuration files.
   - local configuration files will be loaded after non-local files, so
     every configuration entry may be overridden
   - local components behave like non local ones
   - local modules in non local components will be loaded after the non
     local one
   - local classes of non local modules will be loaded instead of the non
     local one the have the same file name
   - local classes of non local modules will be loaded after the non
     local one if the local name is <class>.inc.add.rb for the non local
     file name <class>.inc.rb; this may be for examle used to create
     a costumer specific copy of a non local class with one or more
     overwritten methods
 - license
   This directory refences all licences the framework and the used
   libraries are under. You may use this directory to reference the
   licence of yout application or the libraries used by your
   application. 
 - doc
   the content of this directory does not follow any specific
   structure, but we recommend a separation between the documentation of the
   ghun framework, the documentation of your changes to the framework,
   and the documentation of your application. The content of this
   directory or the directory is not used from Ghun
 - data (data_path in blackboard)
   the content of this directory does not follow any specific structure
   and is a placeholder for a data storage directory.

Possible directory layout when using a gt checkout of ghun, git for your
application, and a separate git repository for costumer specific files
in the local subtree

./      (one above top_level)
./ghun   (ghun checkout)
./<app>  (your application)
./<cs>   (customer specific)
./working
 






