diff --git a/README b/README deleted file mode 100644 index b10730a..0000000 --- a/README +++ /dev/null @@ -1,33 +0,0 @@ -= What is shunit - -shunit is just a set of bash functions for producing unit test output from bash scripts. I wrote this library because I often found myself writing things in bash whose output I wanted to consume as discrete pass/fail tasks into Bamboo, so I wrote the junit functions. Then later on, I got sick and tired of (as a human) reading junit output, so I wrote the tunit functions, so my scripts could output tunit or junit depending on which flags I passed. - -Complete documentation is inside the functions (each function has --help) in ./lib/*unit.sh. A pair of complete examples are in tests/*unit.sh. - -= Example output - - akesterson@akesterson-pc ~/source/upstream/git/shunit - $ bash tests/tunit.sh - - ==== 0 TESTS in 0 SECONDS : 0 ERRORS, 0 FAILURES ==== - [super::class] someTest .... [OK] - [super::class] someOtherTest .... [FAILED] - generic failure : Yo dawg, I heard you like failures - This is some raw data, please read it - - - akesterson@akesterson-pc ~/source/upstream/git/shunit - $ bash tests/junit.sh - - - - - - - - - - - diff --git a/README.md b/README.md index 739d3f2..c3ab278 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ shunit ====== -Functions for producing unit test results from bash scripts in junit or human-friendly formats \ No newline at end of file +shunit is just a set of bash functions for producing unit test output from bash scripts. I wrote this library because I often found myself writing things in bash whose output I wanted to consume as discrete pass/fail tasks into Bamboo, so I wrote the junit functions. Then later on, I got sick and tired of (as a human) reading junit output, so I wrote the tunit functions, so my scripts could output tunit or junit depending on which flags I passed. + +Complete documentation is inside the functions (each function has --help) in ./lib/*unit.sh. A pair of complete examples are in tests/*unit.sh. + +Example output +============== + + akesterson@akesterson-pc ~/source/upstream/git/shunit + $ bash tests/tunit.sh + + ==== 0 TESTS in 0 SECONDS : 0 ERRORS, 0 FAILURES ==== + [super::class] someTest .... [OK] + [super::class] someOtherTest .... [FAILED] + generic failure : Yo dawg, I heard you like failures + This is some raw data, please read it + + + akesterson@akesterson-pc ~/source/upstream/git/shunit + $ bash tests/junit.sh + + + + + + + + + + +