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 [Simplified Interface page][interface].
  18
  19 [reference]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Reference>
  20 [interface]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Simplified-Interface>
  21
  22 ### How to use lisp-unit
  23
  24 The core definitions of *lisp-unit* may be used by loading the single
  25 file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
  26 loaded using either [Quicklisp][] or [ASDF][].
  27
  28 1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
  29 2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
  30 3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
  31
  32 ### Version 1 Remaining Tasks
  33
  34 * (0.9.0) Test tags to facilitate running test subsets.
  35 * (1.0.0) Expanded internal testing.
  36
  37 ### Future Features
  38
  39 * Fixtures
  40 * Test Suites
  41 * Benchmarking tools
  42 * Test Anything Protocol(TAP) support.
  43
  44 [orig]: <http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html>
  45   "Original Lisp Unit"
  46 [wiki]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki>
  47   "Lisp Unit Wiki"
  48 [JUnit]: <http://www.junit.org> "JUnit"
  49 [Quicklisp]: <http://www.quicklisp.org> "Quicklisp"
  50 [ASDF]: <http://common-lisp.net/project/asdf/> "ASDF"