aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Krahl <me@robin-krahl.de>2018-04-04 14:58:08 +0200
committerSzczepan Zalega <szczepan@nitrokey.com>2018-04-10 08:02:25 +0200
commitccea8b434141f525fbe6c7381516a4d34ade8450 (patch)
tree5f0679417766c383d47d793e74ebc960bcfa4c1a
parent320dee676971f7116f9e28d759e4feb0a36729a4 (diff)
downloadlibnitrokey-ccea8b434141f525fbe6c7381516a4d34ade8450.tar.gz
libnitrokey-ccea8b434141f525fbe6c7381516a4d34ade8450.tar.bz2
Fix suggested CMake options in readme
The readme suggested to use the option `-DCOMPILE_TESTS` for CMake in order to compile unit tests. Yet CMake expectes option values of the form `<var>:<type>=<value>` or `<var>=<value>` (see cmake(1)). Therefore, this patch replaces `-DCOMPILE_TESTS` with `-DCOMPILE_TESTS=ON`, matching the general build instructions in the CMake section.
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index f0ca3b1..81b367a 100644
--- a/README.md
+++ b/README.md
@@ -184,7 +184,7 @@ For additional documentation please check the following for [py.test installatio
## C++ tests
There are also some unit tests implemented in C++, placed in unittest directory. They are not written as extensively as Python tests and are rather more a C++ low level interface check, often not using C++ API from `NitrokeyManager.cc`. Some of them are: [test_HOTP.cc](https://github.com/Nitrokey/libnitrokey/blob/master/unittest/test_HOTP.cc),
[test.cc](https://github.com/Nitrokey/libnitrokey/blob/master/unittest/test.cc).
-Unit tests were written and tested on Ubuntu 16.04/16.10/17.04. To run them just execute binaries built in ./libnitrokey/build dir after enabling them by passing `-DCOMPILE_TESTS` option like in `cmake .. -DCOMPILE_TESTS && make`.
+Unit tests were written and tested on Ubuntu 16.04/16.10/17.04. To run them just execute binaries built in ./libnitrokey/build dir after enabling them by passing `-DCOMPILE_TESTS=ON` option like in `cmake .. -DCOMPILE_TESTS=ON && make`.
The documentation of how it works could be found in nitrokey-app project's README on Github: