summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/unittest-cpp/docs/Building-Using-CMake.md
diff options
context:
space:
mode:
author Miodrag Milanovic <mmicko@gmail.com>2015-05-27 15:00:06 +0200
committer Miodrag Milanovic <mmicko@gmail.com>2015-05-27 15:00:06 +0200
commitee4adf600bdd3aa60cc0e92a39f2111be0a90bc6 (patch)
tree5ecb86b72eef1c19ad3ab6c7ba8d8b2a964e0cb9 /3rdparty/unittest-cpp/docs/Building-Using-CMake.md
parent55fa9840f263361efc73126c3f41be606fea7168 (diff)
Added library for supporting unit tests (nw)
Diffstat (limited to '3rdparty/unittest-cpp/docs/Building-Using-CMake.md')
-rw-r--r--3rdparty/unittest-cpp/docs/Building-Using-CMake.md19
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.