some further opinions on readme and the essense of the pitch
commit 563bee7ae12c99f2163f913a3a039a8e5ac29992 · parent 9a69562881
· browse this tree
warpfork, 2026-10-24 11:21:00 UTC
diff --git a/README.md b/README.md index 0cb2538..a138b1c 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,16 @@ testmark-bash testmark-bash reads, checks, and patches [testmark](https://testmark.dev/) documents, from bash. Testmark is data in markdown: a fenced code block, named by a comment line just above it. -That makes a markdown file a good home for test fixtures: -the prose around them explains them, they render nicely anywhere markdown does, and a program can rewrite them. +It makes a markdown file a good home for test fixtures: +the prose around them explains them, they render nicely anywhere markdown does, +and yet a program can easily read the data hunks (and write and rewrite them, on demand). -So with this library, a bash test can check a tool's output against a block in a markdown file; -and when the output changes on purpose, rewrite the block, and leave you a `git diff` to review. +With this library, a simple bash script can either use markdown files for plain data storage... + +Or... go all the way into literate test-driven development with fixtures: +check any command or script's output against a block of data in a markdown file; +AND have an easy way to regenerate the block's content from that selfsame script on demand, +which makes it easy to update fixtures when output changes on purpose. ```bash source path/to/lib/testmark.bash