This package provides [Text-Runner](https://github.com/kevgo/text-runner) actions for verifying documentation mentioning [Make](https://en.wikipedia.org/wiki/Make_(software)) targets.
npm install textrun-makeThis package provides Text-Runner
actions for verifying documentation mentioning
Make) targets.
To use these actions, add this package as a development dependency by runningnpm i -D textrun-make.
The make/command action verifies that the
mentioned Make command exists. As an example,
consider a codebase that contains this Makefile:
```
foo:
echo building foo
In the documentation of this codebase, for example its README.md file, we
want to document how to build it. This part could look like this:
`html`
Build the foo package by running make foo
Text-Runner verifies that the Makefile contains the foo target.
The make/target action verifies that the
mentioned Make target exists. In our example
codebase the README.md file could contain another part:
`html`
If it doesn't work, just run the foo target
again.
Text-Runner verifies that the Makefile contains the foo target.
If the Makefile is not in the root directory of your documentation base, you can
specify its directory using the dir attribute.
As an example, this _README.md_ file
tells Text-Runner to use the Makefile in the parent directory of the
documentation base:
`html``
Build the foo package by runningmake foo