Skip to content

Commit

Permalink
#32: move testing documentation to a separated md file
Browse files Browse the repository at this point in the history
  • Loading branch information
tlamonthezie committed Jul 1, 2024
1 parent 3062f64 commit d093f44
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
11 changes: 0 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions TESTING.md
Original file line number Diff line number Diff line change
@@ -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"`

0 comments on commit d093f44

Please sign in to comment.