README

                                    README

NAME
     exercise - a simple but flexible test runner
     test.h   - terribly simple (unit) tests in C

DESCRIPTION
     This project implements a small program to run tests and track their
     results. A running status is displayed on the console that is designed to
     be unintrusive and pleasing in case of success, as well as clear and to
     the point in case of failure.

     The executable is designed to be small and self-contained enough to be
     distributed with any project that uses it. It depends only on Tcl 8.4 or
     later.

     Tests are realized as simple executables that should signal success or
     failure by their exit status and may print arbitrary diagnostics to
     standard error. Executables that integrate multiple test cases can use a
     straightforward reporting format on standard output to communicate their
     status.

     Further included is a single-header library for testing C programs. It is
     likewise designed to be minimal, straightforward and flexible. By design,
     its output format differs from the report format understood by exercise;
     a simple adapter script is provided.

     Refer to the man pages in the man/ subdirectory for documentation. They
     can be viewed with 'man -l <file>'.

FILES
     README         project overview
     TODO           future work
     exercise       main executable
     man/           manual pages
     support/       C language support (test.h) and adapter script
     tests/         self tests

AUTHORS
     Sven M. Hallberg <pesco@khjk.org>

                                August 9, 2025