diff options
Diffstat (limited to '3rdparty/unittest-cpp/docs/Building-Using-CMake.md')
-rw-r--r-- | 3rdparty/unittest-cpp/docs/Building-Using-CMake.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/3rdparty/unittest-cpp/docs/Building-Using-CMake.md b/3rdparty/unittest-cpp/docs/Building-Using-CMake.md new file mode 100644 index 00000000000..bd24a0eec6d --- /dev/null +++ b/3rdparty/unittest-cpp/docs/Building-Using-CMake.md @@ -0,0 +1,19 @@ +While there are some bundled makefiles and projects, UnitTest++ is primarily built and supported using [CMake](http://cmake.org). This guide assumes you have already downloaded and installed CMake, and that you have already downloaded the UnitTest++ source. + + +In Two Easy Steps +------------------- + +Once you've obtained the UnitTest++ source, you can use the empty 'builds' folder as a place to put your cmake-generated project files. The valid "generators" differ per platform; you can run `cmake --help` to see which ones are supported on your platform. + + cd path/to/unittest-cpp/builds + cmake -G "<Choose a valid generator>" ../ + cmake --build ./ + +This will build the library and the self-tests, and also run the self-tests. + +Then, if you already understand what CMake does (or are just reckless), and you'd like to run the install step: + + cmake --build ./ --target install + +This will install the headers and built libs to the `CMAKE_INSTALL_PREFIX`. Note this might require a `sudo` in *nix or an Administrative Command Prompt on Windows depending on your system configuration. |