Skip to content

Commit

Permalink
Add info about using cpputils library.
Browse files Browse the repository at this point in the history
  • Loading branch information
przemek83 committed Sep 5, 2024
1 parent 61a3f48 commit cec84d0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ As a result of compilation, binary for simulations and binary for testing should
| yaml-cpp | 0.8.0 | 0.8.0 |
| Catch2 | 3.3.0 | 3.3.0 |
| Argparse | 3.0 | 3.0 |
| cpputils | 1.0.0 | 1.0.0 |

## Used tools for plots part
| Tool | Ubuntu |
Expand Down Expand Up @@ -247,6 +248,7 @@ The project uses the following open-source software:
| yaml-cpp | MIT | https://github.com/jbeder/yaml-cpp | YAML parser library for C++ |
| Catch2 | BSL-1.0 | https://github.com/catchorg/Catch2 | testing framework for C++ |
| Argparse | MIT | https://github.com/p-ranav/argparse | an argument parser for C++ |
| cpputils | MIT | https://github.com/przemek83/cpputils| collection of C++ utility classes |

# Testing
For testing of code logic, there is a responsible `Catch2` framework. As it is well integrated with `CMake` it should be straightforward to use. As the first step, build the project. Make sure that the `penna-model-test` target is built. Modern IDEs supporting CMake also support running tests with monitoring of failures. But in case you would like to run it manually, go to the `tests` directory, where the⁣ binary `penna-model-tests` should be available after building. Calling it directly should produce the following output on Linux:
Expand Down

0 comments on commit cec84d0

Please sign in to comment.