# vim: set ft=text80:
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
#
# Author   : Kenneth J. Pronovici <pronovic@ieee.org>
# Project  : WordUtils
# Revision : $Id: README,v 1.1 2003/07/16 05:23:04 pronovic Exp $
# Purpose  : README for package
#
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

The WordUtils package provides objects related to word searching and
matching.  The eventual goal is to develop a suite of objects that are
suitable for building word games in the tradition of Scrabble (tm).

All of the objects provide similar functionality with a similar interface,
but are implemented in terms of different underlying data structures.
Currently, objects implementing two different data structures are complete:
the Dawg object, which implements a directed acyclic word graph, and the
TernarySearchTree object, which implements a ternary search tree.

The versioning scheme, X.Y.Z, follows a standard library versioning
convention.  Updates to the major version number X are made for
backwards-incompatible interface changes, updates to the minor version
number Y are made for backwards-compatible interface changes, and updates
to the micro version number Z are made for all other changes.

This package was originally developed by Kenneth J. Pronovici and was
hosted at cedar-solutions.com.  Ken has since given up primary
maintainership of the package, and it is now hosted at SourceForge where
most ongoing development will be done by Bob Gibson.  The 0.8.1 release is
the last release compatible with the original public interface.
