From b25165a7cfbdcfc9263ad31e1c386a850ec074b3 Mon Sep 17 00:00:00 2001 From: james Date: Sun, 30 Jan 2022 22:43:25 +0000 Subject: [PATCH] Add new instructions to be more clear on how to get Catch2 --- docs/cmake-integration.md | 6 ++++++ docs/tutorial.md | 2 ++ 2 files changed, 8 insertions(+) diff --git a/docs/cmake-integration.md b/docs/cmake-integration.md index 88425353..cf35409d 100644 --- a/docs/cmake-integration.md +++ b/docs/cmake-integration.md @@ -312,6 +312,12 @@ when configuring the build, and then modify your calls to [find_package](https://cmake.org/cmake/help/latest/command/find_package.html) accordingly. +If you are on windows you will need to use an admin level powershell or command prompt and run the command: + +``` +cmake --build build/ --target install +``` + ## Installing Catch2 from vcpkg Alternatively, you can build and install Catch2 using [vcpkg](https://github.com/microsoft/vcpkg/) dependency manager: diff --git a/docs/tutorial.md b/docs/tutorial.md index c26cfa09..86c853c0 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -12,6 +12,8 @@ ## Getting Catch2 +Before using Catch2 you need to install it via a package manager, using [git](cmake-integration.md#installing-catch2-from-git-repository) or via [vcpkg](cmake-integration.md#installing-catch2-from-vcpkg) + Ideally you should be using Catch2 through its [CMake integration](cmake-integration.md#top). Catch2 also provides pkg-config files and single TU distribution, but this documentation will assume you are using CMake. If you are using single-TU