d Document how to use Approval Tests with vcpkg (#187)

Co-Authored-By: Llewellyn Falco <[email protected]>
approvals · Jul 30, 2021 · 990ff33 · 990ff33
1 parent 9fe8042
commit 990ff33
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 2 deletions.
diff --git a/build/relnotes_x.y.z.md b/build/relnotes_x.y.z.md
@@ -3,7 +3,7 @@
 * **Breaking changes**
     * None
 * **New features**
-    * None
+    * Vcpkg integration added: See [Vcpkg Integration docs](/doc/VcpkgIntegration.md#top) ([vcpkg #18338](https://github.com/microsoft/vcpkg/pull/18338) - thanks @strega-nil!)
 * **Bug fixes**
     * None
 * **Other changes**

diff --git a/doc/Features.md b/doc/Features.md
@@ -6,6 +6,7 @@
 ## Contents
 
   * [v.x.y.z](#vxyz)
+    * [Vcpkg Integration](#vcpkg-integration)
   * [v.10.9.0](#v1090)
     * [Custom template namer](#custom-template-namer)
     * [Options.withNamer()](#optionswithnamer)
@@ -76,6 +77,10 @@
 
 ## v.x.y.z
 
+### Vcpkg Integration
+
+See [Vcpkg Integration](/doc/VcpkgIntegration.md#top).
+
 ## v.10.9.0
 
 ### Custom template namer

diff --git a/doc/README.md b/doc/README.md
@@ -111,7 +111,8 @@ effectively.
 
   - **Integrations**:
     [CMake](/doc/CMakeIntegration.md#top) |
-    [Conan](/doc/ConanIntegration.md#top)
+    [Conan](/doc/ConanIntegration.md#top) |
+    [Vcpkg](/doc/VcpkgIntegration.md#top)
   - **Your builds**:
     [Build Machines and CI servers](/doc/BuildMachinesAndCI.md#top)
 

diff --git a/doc/VcpkgIntegration.md b/doc/VcpkgIntegration.md
@@ -0,0 +1,34 @@
+<a id="top"></a>
+
+# Vcpkg Integration
+
+<!-- toc -->
+## Contents
+
+  * [Using vcpkg to obtain ApprovalTests.cpp](#using-vcpkg-to-obtain-approvaltestscpp)
+  * [Links](#links)<!-- endToc -->
+
+## Using vcpkg to obtain ApprovalTests.cpp
+
+Approval Tests is available via vcpkg, since v.10.9.1
+
+Windows:
+
+```bash
+.\vcpkg install approval-tests-cpp
+```
+
+Linux/Mac:
+
+```bash
+vcpkg install approval-tests-cpp
+```
+
+## Links
+
+* For users: [approval-tests-cpp in vcpkg.io](https://vcpkg.io/en/packages.html?query=approval-tests-cpp)
+* For maintainers: [the vcpkg port: approval-tests-cpp](https://github.com/microsoft/vcpkg/tree/master/ports/approval-tests-cpp)
+
+---
+
+[Back to User Guide](/doc/README.md#top)
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
@@ -195,6 +195,7 @@ Build Systems
 
    generated_docs/CMakeIntegration
    generated_docs/ConanIntegration
+   generated_docs/VcpkgIntegration
 
    generated_docs/BuildMachinesAndCI