xref: /src/external/bsd/atf/dist/README

                     Automated Testing Framework (atf)
                        The NetBSD Foundation, Inc.
---------------------------------------------------------------------------


Introduction
============

The Automated Testing Framework (ATF) is a collection of libraries and
utilities designed to ease unattended application testing in the hands of
developers and end users of a specific piece of software.

As regards developers, ATF provides the necessary means to easily create
test suites composed of multiple test programs, which in turn are a
collection of test cases.  It also attempts to simplify the debugging of
problems when these test cases detect an error by providing as much
information as possible about the failure.

As regards users, it simplifies the process of running the test suites and,
in special, encourages end users to run them often: they do not need to
have source trees around nor any other development tools installed to be
able to certify that a given piece of software works on their machine as
advertised.


Other documents
===============

* AUTHORS: List of authors and contributors for this project.

* COPYING: License information.

* ChangeLog: Pointers to the code repository.  No actual history is
  provided here.

* INSTALL: Compilation and installation instructions.  These is not the
  standard document shipped with many packages, so be sure to read it for
  things that are specific to ATF's build.

* NEWS: List of major changes between formal, published releases.

* ROADMAP: List of changes planned for future releases.


Contributing
============

If you are planning to contribute code to the project, be absolutely sure
to read doc/hacking.txt first.


---------------------------------------------------------------------------
                              End of document