# vim: set ft=text80:
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
#
#              C E D A R
#          S O L U T I O N S       "Software done right."
#           S O F T W A R E
#
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
#
# Author   : Kenneth J. Pronovici <pronovic@ieee.org>
# Language : N/A
# 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.

See http://cedar-solutions.com/software/wordutils/ for more information
on the WordUtils package.

A note on licensing: I've released this code under the GPL because that's
what I generally put my software under.  However, I realize that it's often
better to put library-style code under a BSD or LGPL license.  Write me
personally if for some reason the GPL license is causing you problems, and
I'm sure that we can work something out.

