Sha256: 0d85fe7be7532305ab179974079fb87ff8ec12388215cd6a0d92996a46b6442f
Contents?: true
Size: 1.26 KB
Versions: 14
Compression:
Stored size: 1.26 KB
Contents
[<< back](README.md)
# Example: readme
Create README files (with test instructions) from our test definition.
## Definition section
Take a look at our test definition section (Group):
```ruby
group "Customize readme output" do
readme "This is our README example."
readme "And here we'll see how to use readme keyword"
target "Create user david."
readme "Help: you can use 'useradd' command to create users."
readme "Remember: Only root is permitted to create new users."
run "id david"
expect "david"
end
```
> In this example, localhost's OS must be GNU/Linux (any other compatible OS) because the command used is `id david`.
There exists some `readme` instructions after `group` and `target` lines.
## Execute command
To generate automatically a README file from previous test, execute this:
```
teuton readme example/15-readme > example/15-readme/README.md
```
## Result
**Let's see the output**: Content of `example/15-readme/README.md` file.
---
# 15-readme
## Customize readme output
This is our readme example.
And here we'll see how to use readme keyword
Go to [LOCALHOST](#required-hosts) host, and do next:
* Create user david.
* Help: you can use 'useradd' command to create users.
* Remember: Only root is permitted to create new users.
Version data entries
14 entries across 14 versions & 1 rubygems