#############################################################################
#
#     This Cplant(TM) source code is the property of Sandia National
#     Laboratories.
#
#     This Cplant(TM) source code is copyrighted by Sandia National
#     Laboratories.
#
#     The redistribution of this Cplant(TM) source code is subject to the
#     terms of the GNU Lesser General Public License
#     (see cit/LGPL or http://www.gnu.org/licenses/lgpl.html)
#
#     Cplant(TM) Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 
#     Sandia Corporation. 
#     Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
#     license for use of this work by or on behalf of the US Government.
#     Export of this program may require a license from the United States
#     Government.
#
#############################################################################

See the CIT homepage at http://www.cs.sandia.gov/cit for more information on 
CIT and most importantly for various CIT publications that describe the 
design of CIT in detail. (http://www.cs.sandia.gov/cit/publications/index.html)

GETTING HELP
------------------
The CIToolkit provides a number of resources for futher information.
To summarize, these include the following:

     - README files located under <module>/README
     - Installation and other documentation located <module>/doc 
     - Scripts support the  --help command 
     - Pod documentation
    
The doc directory of each module will contain a README file in its toplevel 
directory <module>/README that provides a overview of that module. 
In addition to this file, each module will have its own doc directory 
<module>/doc that will contain detailed installation instructions in addition 
to any other documentation for that module, if available. In particular, 
the doc directory of your base installation (CIT_HOME) will contain a number 
of useful files that provide more information about the CIT. In particular, 
the WELCOME_to_the CIToolkit document provides an overview of the toolkit, 
description of the directory structure, as well as the vision for the future. 

In addition to the documentation in the base directory and the documentation 
specific to each module, most scripts support the '--help' option. If this 
option is not available, there are useful comments at the top of each file. 
Additionally, the CIToolkit employs pod (plain old documentation) 
a type of embedded documentation that can easily be accessed by using by simply 
typing the perldoc command followed by the name of the module. 
For example, to access the documentation about the ACME module, 
located under cluster/lib/Device/Node, simply type the following 
command: 

     perldoc ACME.pm 

Perl contains several pod translators that convert pod into different formats. 
These include pod2text, pod2man, and pod2html.


Please send bugs, comments etc to the CIT mailing list: cit-dev@sandia.gov