From d5656bc4301634565f293c2329ebbb897df9c01c Mon Sep 17 00:00:00 2001 From: Josh Love Date: Tue, 30 Oct 2018 16:11:23 -0400 Subject: [PATCH 1/3] Added what arnavb suggested on april 18th. As well as I will be submiting a pr. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 95805a1..2c65885 100644 --- a/README.md +++ b/README.md @@ -235,6 +235,17 @@ On Linux and macOS, you can compile and run the tests using the command line. Then you can simply select which target (unit test) you want to build/run, and your IDE will do the rest. +For example in visual studio you might run these commands: +**`mkdir build && cd build +cmake -D -G .. +cmake --build . --config # Default build +cmake --build . --target --config # Other targets, such as + # coverage or test. For testing, ctest is a better option.`** +* are any options you pass to CMake (except CMAKE_BUILD_TYPE which doesn't work for multi-config generators anyways). +* is a visual studio generator such as those listed here. +* needs to be a valid CMake configuration (Debug, Release, DebWithRelInfo, MinSizeRel). If it is excluded, the default configuration is (usually) Debug. +* can be any build target. Eg for any target make , you have to pass --target to cmake --build. + In case your IDE does not support CMake directly, you will need to run `cmake` via the command line with the appropriate flags to generate the project files for your IDE. Give it a try, it's not supposed to be hard! From 0bca4c32fbf41c3ad1cfe292ce278faf68b50761 Mon Sep 17 00:00:00 2001 From: Josh Love Date: Tue, 30 Oct 2018 16:20:51 -0400 Subject: [PATCH 2/3] Made it so the code is now in a code block! --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c65885..5cf9624 100644 --- a/README.md +++ b/README.md @@ -236,16 +236,18 @@ Then you can simply select which target (unit test) you want to build/run, and your IDE will do the rest. For example in visual studio you might run these commands: -**`mkdir build && cd build +``` +mkdir build && cd build cmake -D -G .. cmake --build . --config # Default build cmake --build . --target --config # Other targets, such as - # coverage or test. For testing, ctest is a better option.`** + # coverage or test. For testing, ctest is a better option. +``` * are any options you pass to CMake (except CMAKE_BUILD_TYPE which doesn't work for multi-config generators anyways). * is a visual studio generator such as those listed here. * needs to be a valid CMake configuration (Debug, Release, DebWithRelInfo, MinSizeRel). If it is excluded, the default configuration is (usually) Debug. * can be any build target. Eg for any target make , you have to pass --target to cmake --build. - + In case your IDE does not support CMake directly, you will need to run `cmake` via the command line with the appropriate flags to generate the project files for your IDE. Give it a try, it's not supposed to be hard! From c473484fbdbaa126b609ee5403d723d6d32fb5ea Mon Sep 17 00:00:00 2001 From: Josh Love Date: Tue, 30 Oct 2018 16:24:11 -0400 Subject: [PATCH 3/3] Fixed some typos! --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5cf9624..d2caeed 100644 --- a/README.md +++ b/README.md @@ -243,10 +243,10 @@ cmake --build . --config # Default build cmake --build . --target --config # Other targets, such as # coverage or test. For testing, ctest is a better option. ``` -* are any options you pass to CMake (except CMAKE_BUILD_TYPE which doesn't work for multi-config generators anyways). -* is a visual studio generator such as those listed here. -* needs to be a valid CMake configuration (Debug, Release, DebWithRelInfo, MinSizeRel). If it is excluded, the default configuration is (usually) Debug. -* can be any build target. Eg for any target make , you have to pass --target to cmake --build. +* `` are any options you pass to CMake (except CMAKE_BUILD_TYPE which doesn't work for multi-config generators anyways). +* `` is a visual studio generator such as those listed here. +* `` needs to be a valid CMake configuration (Debug, Release, DebWithRelInfo, MinSizeRel). If it is excluded, the default configuration is (usually) Debug. +* `` can be any build target. Eg for any target make ``, you have to pass --target `` to cmake --build. In case your IDE does not support CMake directly, you will need to run `cmake` via the command line with the appropriate flags to generate the project files