feat: FetchContent example

Author: JPHutchins

.github/workflows/release.yaml

@@ -29,3 +29,10 @@ jobs:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
           file: build/test_cmake.zip
           tag: ${{ github.ref }}
+
+      - name: Add fetch_test_cmake.cmake to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: fetch_test_cmake.cmake
+          tag: ${{ github.ref }}

README.md

@@ -1,10 +1,23 @@
 # `test_cmake`
 
-Unit test framework CMake projects.
+Unit test framework for CMake projects.
+
+# Include in your CMake project
+
+The easiest way to use this library in your project is to use CMake's [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) API.
+
+* Commit the FetchContent script to your repository:
+  ```
+  wget https://github.com/intercreate/test-cmake/releases/latest/download/fetch_test_cmake.cmake
+  ```
+* Include it wherever you'd like to use functions from this library:
+  ```
+  include(fetch_test_cmake.cmake)
+  ```
 
 # Contributions
 
 * Fork this repository: https://github.com/intercreate/test-cmake/fork
 * Clone your fork: `git clone git@github.com:<YOUR_FORK>/test-cmake.git`
   * then change directory to your cloned fork: `cd test-cmake`
-* Enabled the githook: `git config core.hooksPath .githooks`
+* Enabled the githook: `git config core.hooksPath .githooks`

fetch_test_cmake.cmake

@@ -0,0 +1,14 @@
+# Copyright (c) 2023 Intercreate, Inc.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Authors: J.P. Hutchins <jp@intercreate.io>
+
+include(FetchContent)
+
+FetchContent_Declare(test_cmake
+    URL https://github.com/intercreate/test-cmake/releases/latest/download/test_cmake.zip
+    DOWNLOAD_EXTRACT_TIMESTAMP true
+)
+FetchContent_MakeAvailable(test_cmake)
+
+include(${CMAKE_BINARY_DIR}/_deps/test_cmake-src/test_cmake.cmake)