README.md

   1 ## lisp-unit
   2
   3 *lisp-unit* is a Common Lisp library that supports unit testing. It is
   4 an extension of the [library written by Chris Riesbeck][orig]. There
   5 is a long history of testing packages in Lisp, usually called
   6 "regression" testers. More recent packages in Lisp and other languages
   7 have been inspired by [JUnit for Java][JUnit].
   8
   9 [Documentation is located on the project wiki.][wiki]
  10
  11 ## Simplified Interface
  12
  13 The interface for managing tests has been simplified beginning in
  14 Version 0.9.0. The simplified interface is fully described on the
  15 [Reference page][Reference]. The motivation for simplifying the
  16 interface and a comparison with the original interface is described on
  17 the [Interface page][Interface].
  18
  19 [Interface]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Interface>
  20
  21 ### How to use lisp-unit
  22
  23 The core definitions of *lisp-unit* may be used by loading the single
  24 file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
  25 loaded using either [Quicklisp][] or [ASDF][].
  26
  27 1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
  28 2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
  29 3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
  30
  31 ### Version 1 Remaining Tasks
  32
  33 * (0.9.0) Test tags to facilitate running test subsets.
  34 * (1.0.0) Expanded internal testing.
  35
  36 ### Future Features
  37
  38 * Fixtures
  39 * Test Suites
  40 * Benchmarking tools
  41 * Test Anything Protocol(TAP) support.
  42
  43 [orig]: <http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html>
  44   "Original Lisp Unit"
  45 [wiki]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki>
  46   "Lisp Unit Wiki"
  47 [JUnit]: <http://www.junit.org> "JUnit"
  48 [Quicklisp]: <http://www.quicklisp.org> "Quicklisp"
  49 [ASDF]: <http://common-lisp.net/project/asdf/> "ASDF"