summaryrefslogtreecommitdiff
path: root/macros/generic/markdown/tests/README.md
blob: 53db58776b475f9231149531fe9780d11141e65b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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)