Expanded on new features in 0.9.0 in the README.
authorThomas M. Hermann <thomas.m.hermann@odonata-research.com>
Sat, 13 Oct 2012 16:55:56 +0000 (13 11:55 -0500)
committerThomas M. Hermann <thomas.m.hermann@odonata-research.com>
Sat, 13 Oct 2012 16:55:56 +0000 (13 11:55 -0500)
README.md

index 174b87e..f468fd8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,7 +8,19 @@ have been inspired by [JUnit for Java][JUnit].
 
 [Documentation is located on the project wiki.][wiki]
 
-## Simplified Interface
+### How to use lisp-unit
+
+The core definitions of *lisp-unit* may be used by loading the single
+file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
+loaded using either [Quicklisp][] or [ASDF][].
+
+1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
+2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
+3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
+
+## Version 0.9.0 Features
+
+### Simplified Interface
 
 The interface for managing tests has been simplified beginning in
 Version 0.9.0. The simplified interface is fully described on the
@@ -19,19 +31,19 @@ the [Simplified Interface page][interface].
 [reference]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Reference>
 [interface]: <https://github.com/OdonataResearchLLC/lisp-unit/wiki/Simplified-Interface>
 
-### How to use lisp-unit
+### Test Documentation
 
-The core definitions of *lisp-unit* may be used by loading the single
-file 'lisp-unit.lisp'. To use the extensions, *lisp-unit* must be
-loaded using either [Quicklisp][] or [ASDF][].
+A documentation string can now be used in `define-test` like it is in
+`defun`.
 
-1. Load (or compile and load) as a single file : `(load "lisp-unit")`.
-2. Load using [Quicklisp][] : `(ql:quickload :lisp-unit)`.
-3. Load using [ASDF][] : `(asdf:load-system :lisp-unit)`.
+### Test tags
+
+Tests can be tagged by adding on or more `(:tag tag1 tag2 ...)` forms
+after the name or documentation string in `define-test`. The tags can
+then be used to run subsets of the unit tests with `run-tags`.
 
-### Version 1 Remaining Tasks
+## Version 1 Remaining Tasks
 
-* (0.9.0) Test tags to facilitate running test subsets.
 * (1.0.0) Expanded internal testing.
 
 ### Future Features