From a56493916383089d4b6d3a90f58d19d5a10ea1f2 Mon Sep 17 00:00:00 2001 From: Frank Sauerburger <frank@sauerburger.com> Date: Wed, 9 Aug 2017 14:51:13 +0200 Subject: [PATCH] Update README to match version 0.2.0 Update the console output in the example in order to match the output generated by the improved version 0.2.0. --- README.md | 41 ++++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 913a379..bf961c9 100644 --- a/README.md +++ b/README.md @@ -58,11 +58,11 @@ Please note, that leading white spaces before `<!--` are not allowed. The line immediately after the command line must be the beginning of a Markdown code block. +<pre> +```bash +$ echo "Hello World!" ``` - ```bash - $ echo "Hello World!" - ``` -``` +</pre> The language indication, here `bash`, is ignored. Everything inside the code block is taken as the content of the operation. @@ -79,23 +79,30 @@ explained in a text, but should be executed as a script for testing. ### Example A full example of a imaginary bash tutorial (hello_world.md) can look like this. -```markdown - A mandatory step in learning a new technology in computer science is to - run a 'hello world' example. Your first step in bash should be no exception. - Open a bash shell and type everything after the `$` sign and hit return. - The shell should greet you and everybody else in the world as shown in - this example. - <!-- console_output --> - ```bash - $ echo "Hello World!" - Hello World! - ``` +<pre> +A mandatory step in learning a new technology in computer science is to +run a 'hello world' example. Your first step in bash should be no exception. +Open a bash shell and type everything after the `$` sign and hit return. +The shell should greet you and everybody else in the world as shown in +this example. +<!-- console_output --> +```bash +$ echo "Hello World!" +Hello World! ``` +</pre> -To verify that this code snipped in this tutorial works as expected run +To verify that the code snipped in this tutorial works as expected run ```bash $ doxec hello_world.md -running console_output(None) ... +/home/esel/rpriv/doxec/hello_world.md:6 console_output ... +--- $ echo "Hello World!" +--- Hello World! +/home/esel/rpriv/doxec/hello_world.md:6 console_output ... done +-------------------------------------------------------------------------------- +Failed: 0 +Total: 1 + ``` The *console_output* command runs the lines starting with `$` in a bash shell and compares the output list below. -- GitLab