Explain how to build the tests
It may not be obvious how to build the tests, so add a section explaining this to the existing file containing the instructions about writing the tests and add a README to the tests directory itself to increase chances that this file will be found -- hopefully anybody interested in the tests will look at the README in the directory containing them.
This commit is contained in:
parent
755ee1cf10
commit
46973762ba
2 changed files with 40 additions and 0 deletions
13
tests/README.md
Normal file
13
tests/README.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
Tests
|
||||
-----
|
||||
|
||||
This directory contains tests for the library and is mostly useful for the
|
||||
library developers. See the `samples` subdirectory for the examples that are
|
||||
more useful to the application developers using the library.
|
||||
|
||||
If you do work on the library itself and would like to modify an existing or
|
||||
add a new test, please see `docs/contributing/how-to-write-unit-tests.md` for
|
||||
more information.
|
||||
|
||||
This file also contains the instructions for running the tests if you'd just
|
||||
like to do it to confirm that the library works correctly.
|
||||
Loading…
Add table
Add a link
Reference in a new issue