summaryrefslogtreecommitdiff
path: root/examples/echo/echo.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-02-17 08:49:38 +0200
committerLars Wirzenius <liw@liw.fi>2021-02-18 10:42:40 +0200
commita85e7d15c57c11d8286656531c7394681fb855d9 (patch)
tree872ec655a99606e8fe2147a4b8d4fb3e1aeb186b /examples/echo/echo.md
parent4b9edb354297353cbbe38575553ca1351f68d380 (diff)
downloadsubplot-a85e7d15c57c11d8286656531c7394681fb855d9.tar.gz
refactor: move echo and muck examples under new examples/ directory
Diffstat (limited to 'examples/echo/echo.md')
-rw-r--r--examples/echo/echo.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/examples/echo/echo.md b/examples/echo/echo.md
new file mode 100644
index 0000000..c335f53
--- /dev/null
+++ b/examples/echo/echo.md
@@ -0,0 +1,52 @@
+---
+title: "**echo**(1) acceptance tests"
+author: The Subplot project
+template: bash
+bindings: echo.yaml
+functions: echo.sh
+bibliography: echo.bib
+...
+
+Introduction
+=============================================================================
+
+**echo**(1) is a Unix command line tool, which writes its command line
+arguments to the standard output. This is a simple acceptance test
+suite for the `/bin/echo` implementation.
+
+For more information, see [@foo2020].
+
+No arguments
+=============================================================================
+
+Run `/bin/echo` without arguments.
+
+```scenario
+when user runs echo without arguments
+then exit code is 0
+then standard output contains a newline
+then standard error is empty
+```
+
+Hello, world
+=============================================================================
+
+This scenario runs `/bin/echo` to produce the output "hello, world".
+
+```scenario
+when user runs echo with arguments hello, world
+then exit code is 0
+then standard output contains "hello, world"
+then standard error is empty
+```
+
+
+Test file
+
+~~~~{.file #foo.dat}
+This is a test file.
+Two lines.
+~~~~
+
+
+# References