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.
  10
  11 ### How to use lisp-unit
  12
  13 The core definitions of *lisp-unit* may be used by loading the single
  14 file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
  15 loaded using either [Quicklisp][] or [ASDF][].
  16
  17 1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
  18 2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
  19 3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
  20
  21 ### Version 1 Remaining Tasks
  22
  23 * (0.8.0) Refined internal test data structures.
  24 * (0.9.0) Improved test report tools.
  25 * (1.0.0) Test Anything Protocol(TAP) support.
  26
  27 ### Future Features
  28
  29 * Fixtures
  30 * Test Suites
  31 * Benchmarking tools
  32
  33 [orig]: <http://www.cs.northwestern.edu/academics/courses/325/readings/lisp-unit.html>
  34   "Original Lisp Unit"
  35 [JUnit]: <http://www.junit.org> "JUnit"
  36 [Quicklisp]: <http://www.quicklisp.org> "Quicklisp"
  37 [ASDF]: <http://common-lisp.net/project/asdf/> "ASDF"