GTKWorkbook -- Spreadsheet Application Framework
John Bellone <jvb4@njit.edu>

LICENSE

	GTKWorkbook is licensed under the GNU General Public License v2, and 
	a copy of which is included in the COPYING file.

SUMMARY

	The file INSTALL in this directory says how to build and install
	the project on various systems, and if you are reading this document
	we are making the assumption that you have the whole source tree.

	The file etc/BUGS contains all known bugs that are currently being
	worked on. If you find any additional bugs please report them on the
	sourceforge.net project site so that they can be added to the queue.

	The etc/PROBLEMS file contains any known problems that exist on certain
	operating system or cpu archtitectures. These are usually bugs that 
	have been researched and found to be a third-party issue.

PROJECT DIRECTORY STRUCTURE

`bin' 			a staging directory created when the 'sh build' 
			command is used. All libraries and executables are
			copied here for testing purposes.

`cfg'			has a demonstration configuration file that must
			be loaded for the application to launch properly.

`etc'			holds miscellaneous files that are useful for 
			development purposes, information about the project, 
			or its developers.

`include'		contains shared include files for any applications, 
			or libraries that used within this distribution. These 
			typically will be installed when a `make install' 
			is performed.

`libgtkworkbook'	this directory holds the gtkworkbook library's source
			files. 

`src'			this directory holds the application's source files. 

`test'			this directory holds all unit tests

SOURCE CONTROL MANAGEMENT

	This project uses git <http://www.git-scm.org> for source control and 
	revision management. There are several tutorials available via Google
	which explain basic instructions on how git operates. 

	The latest changes are available on the GTKWorkbook project page's 
	git repository which is hosted by Sourceforge.net. We currently
	structure our changes in the following fashion:

		  `master'    	 contains the latest *trunk* revision that is
		  		 considered ready to be used for development.
				 
		  `stable'	 contains the latest revision, and any
		  		 additional changes, which is available for 
				 release on Sourceforge.net.

		  `working'	 this is a copy of the branch that is being
		  		 directly worked on currently. If you want to
				 test out any new features this would be the
				 branch to do so in.

UNIT TESTING

	This project uses the Google Test Framework which is available from 
	Google Code <http://code.google.com/p/googletest/> and is licensed 
	under a BSD variant. In order to run the tests you *MUST* have this
	library installed and configured properly. Also, if you install this
	after you first installed GTKWorkbook you must re-run the autogen.sh
	script so it can build the Makefile for the tests.

	Once the Google Test framework is installed you should be able to
	run the tests by performing the following command:

	    make check

	At this point the test cases inside of the `test' directory will be
	compiled and run through the framework. You'll get details on any
	tests that failed. If you decide to add a plugin to the system and
	wish to add your own tests open up Makefile.am and find the section
	dealing with tests (grep for HAVE_GTEST), copy a block, and add any
	test files that you create.

	Documentation on the framework is available from the website (above)
	as well as a mailing list and forum for any questions you may have.