From 164286c053967341736146abd69d54cf9465ccdb Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 9 Jun 2013 11:09:40 +0100 Subject: Add updated README --- README | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 300770b..8c1a39c 100644 --- a/README +++ b/README @@ -1,6 +1,13 @@ README for cmdtest ================== +This project consists of two programs: the original `cmdtest`, +and the newer `yarn`. Both are black box testing tools for Unix +command line tools. + +cmdtest +------- + `cmdtest` black box tests Unix command line tools. Given some test scripts, their inputs, and expected outputs, it verifies that the command line produces the expected output. @@ -9,10 +16,27 @@ If not, it reports problems, and shows the differences. See the manual page for details on how to use the program. +yarn +---- + +`yarn` also black box tests Unix command line tools, but takes +a different approach, where the emphasis is on verifying that the +tools works correctly in a scenario, or sequence of operations, or +what we call a "test story". `yarn` is inspired [BDD][BDD], +behavior-driven development, and some of the implementations made +by the Ruby community. + +See README.yarn for more details. + +`yarn` has been designed with Daniel Silverstone. + +[BDD]: https://en.wikipedia.org/wiki/Behavior-driven_development + + Legalese -------- -Copyright 2011 Lars Wirzenius +Copyright 2011-2013 Lars Wirzenius This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -- cgit v1.2.1