From d306d14963694eefaafc34ce29a97a188625757b Mon Sep 17 00:00:00 2001 From: Thomas Levine Date: Mon, 8 Oct 2012 10:01:29 -0400 Subject: [PATCH] more readme --- readme.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 1f13f45..fa5b689 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,29 @@ -Urchin -==== + , , ,_ _, , , ___, , , + | | |_) / |_|, ' | |\ | + '\__| '| \ '\_ '| | _|_, |'\| + ` ' ` ` ' ` ' ' ` + +Urchin is an experimental language-agnostic lightweight cross-platform test skeleton +written in POSIX-compliant shell, originally designed for test-driven server deployment +at ScraperWiki. + +## Install +Downlolad Urchin like so + + wget https://raw.github.com/scraperwiki/urchin/master/urchin + chmod +x urchin + +Now you can run it. + + ./urchin + +## Writing tests +Make a directory named `tests`. Inside it, put files that begin with `test` +that exit `0` on success and something else on fail. Then run urchin from +the parent directory of the `tests` directory. + +## More about writing tests Tests are organized recursively in directories, where the names of the files and directories have special meanings.