From d093f442f44471da8b651eaeffde96307633d26e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Dutheillet-Lamonth=C3=A9zie?= Date: Mon, 1 Jul 2024 18:57:35 +0200 Subject: [PATCH] #32: move testing documentation to a separated md file --- README.md | 11 ----------- TESTING.md | 12 ++++++++++++ 2 files changed, 12 insertions(+), 11 deletions(-) create mode 100644 TESTING.md diff --git a/README.md b/README.md index b3fa20ff94..cd8578daf2 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,6 @@ tasks over phases. ![Example Output PNG](./docs/example-output-image.png) -## Unit Testing - -Unit tests are implemented with the help of the [Google's C++ test framework](https://github.com/google/googletest). -The tests source files are located under the `tests` directory as test_*.cpp. - -To run the test from the CLI first build vttv then call ctest using the command line: - `ctest --test-dir build` - -To run specific tests you can use the ctest search option: - `ctest --test-dir build --verbose -R "reader"` - ## Building the Python bindings ### Requirements diff --git a/TESTING.md b/TESTING.md new file mode 100644 index 0000000000..b0693b9f53 --- /dev/null +++ b/TESTING.md @@ -0,0 +1,12 @@ +## Unit Testing + +Unit tests are implemented with the help of the [Google's C++ test framework](https://github.com/google/googletest). +The tests source files are located under the `tests` directory as test_*.cpp. + +You might also add an example in the `example` directory which will be also run as a test as defined by the current cmake configuration. + +To run the test from the CLI first build vttv then call ctest using the command line: +`ctest --test-dir build` + +To run specific tests you can use the ctest search option: +`ctest --test-dir build --verbose -R "reader"`