EiffelUnit -- Eiffel Unit Test Framework (version 1.0)
======================================================

EiffelUnit is a regression test framework for Eiffel modeled after the
JUnit framework designed by Kent Beck and Eric Gamma.  EiffelUnit
makes it easy to write small unit tests for Eiffel classes with
automatic validation.

Directories
===========

You will find the following directories in this distribution ...

    bin
        Contains the "etest" perl script that drives the process.

    doc
        EiffelUnit documentation.

    eunit
	Source directory for the programs `eunit' and `eunit-clean'.

    eutils
	Source directory for a utility library required to build the
	`eunit' and `eunit-clean' programs.  This library is *not*
	required when using the EiffelTest library to build test
	cases.  The EUtils library is available separately from
	jweirich@one.net. 

    support
	Support scripts for building this distribution.

    src
        The EiffelUnit Regression Test Framework source code.

    examples
        Example test cases for some simple minded classes.  Provided
        as an example on using EiffelUnit.  Type "make examples" to
	run the example tests. 

    tests
        Unit tests for the basic EiffelUnit framework.  Type "make tests"
	to run the EiffelUnit regression test.

License
=======

All software in EiffelUnit is made available under the Eiffel Forum
Freeware License (yes, even the perl code).  See "forum.txt" for
details (or see http://www.eiffel-forum.org/license/forum.txt)

Availability
============

The latest version of EiffelUnit can be found at

    ftp://ftp.one.net/pub/users/jweirich/eiffeleunit/

Installation
============

Edit the top-level Makefile to set the BINDIR and LIBDIR variables.
BINDIR should be the directory where the eunit and eunit-clean
programs and the etest perl script are to be installed.  LIBDIR should
be the directory where the EiffelUnit source files should be
installed.  Then type "make install-se".

Feedback
========

Direct your comments and questions about EiffelUnit to Jim Weirich
(email: jweirich@one.net).