###############################################################################
# File:   README
# Author: Wade Spires
# Date:   2006/09/07
# Description: Documentation for using library tools
# Availability of a UNIX or GNU/Linux system is assumed.
###############################################################################

Extract the file ws_tools.tar.gz:
	Type 'tar xzf ws_tools.tar.gz' in Linux;
	or 'gunzip ws_tools.tar.gz; tar xf ws_tools.tar' if on an older UNIX system.

The directory 'tools/' should be extracted containing the following files:
	ws_tools.hpp
	Config_File.cpp
	Config_File.hpp
	err_mesg.c
	err_mesg.h
	go
	log_mesg.c
	log_mesg.h
	makefile
	makefile.bak
	Progress_Bar.hpp
	README
	util.cpp
	util.hpp
	test_config/
	test_quotes/

To compile the library and test programs, type 'make'.
To compile the library only, type 'make lib'.
Either way, 'libws_tools.a' is created in the current directory.

To use the library in your programs, you need to include the file 'ws_tools.hpp'
in each header file you intend on using the library in. Then, when compiling
your program, add the following options to g++:
	-I<ws_tools_dir>
	-L<ws_tools_dir>
	-lws_tools
assuming the header files and 'libws_tools.a' are located in <ws_tools_dir>,
e.g., if <ws_tools_dir> is '/home/john_smith/ws_tools/', then add the following
options
	-I'/home/john_smith/ws_tools/'
	-L'/home/john_smith/ws_tools/'
	-lws_tools
to g++ when compiling.
