Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thinks committed Apr 28, 2019
1 parent 10162ed commit 9dd0c77
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,15 @@ thinks::WritePgmImage("my_file.pgm", width, height, pixel_data.data());
```

## Tests
Tests are implemented in the [Catch2](https://github.com/catchorg/Catch2) framework.
The tests for this package are written in the [Catch2](https://github.com/catchorg/Catch2) framework, which is included as a submodule of this repository. Cloning recursively to initialize submodules is not required when using the functionality in this package, only to run the tests.

Running the tests is simple. In a terminal do the following (and similar for `Debug`):
```bash
$ cd d:
$ git clone --recursive git@github.com:/thinks/pnm-io.git D:/pnm-io
$ mkdir build-pnm-io
$ cd build-pnm-io
$ cmake ../pnm-io
$ cmake --build . --config Release
$ ctest . -C Release --verbose
```

0 comments on commit 9dd0c77

Please sign in to comment.