diff options
Diffstat (limited to 'macros/generic/markdown/tests/README.md')
-rw-r--r-- | macros/generic/markdown/tests/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/macros/generic/markdown/tests/README.md b/macros/generic/markdown/tests/README.md new file mode 100644 index 0000000000..53db58776b --- /dev/null +++ b/macros/generic/markdown/tests/README.md @@ -0,0 +1,17 @@ +This directory contains the testing framework of the Markdown package. Tests +act as an ensurance that changes to the package did not introduce new bugs. + +The `test.sh` shell script is used to run the individual tests. To run one or +more tests, execute the `test.sh` script with the pathnames of one or more test +files as the arguments. Test files can be recognized by the `.test` suffix and +reside inside the `testfiles/` directory. The Markdown package needs to be +[installed][install] before running the tests. + + [install]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#installation "Markdown Package User Manual" + +Each time a commit is made to the Git repository of the project, this test +suite is ran by a continuous integration service. +The current status is: +[![CircleCI](https://circleci.com/gh/Witiko/markdown/tree/master.svg)][CircleCI] + + [CircleCI]: https://circleci.com/gh/Witiko/markdown/tree/master (CircleCI) |