Document conventional.cmake

polytypic · polytypic · commit e9d3d62ae307 · 2019-09-21T11:56:12.000+03:00
diff --git a/index.html b/index.html
@@ -311,6 +311,9 @@ <h4><a id="cppsm-upgrade"></a> <a href="#contents">≡</a> <a href="#cppsm-upgra
 <h2><a id="cmake"></a> <a href="#contents">≡</a> <a href="#cmake">CMake</a></h2>
 <p>CMake boilerplate is provided for simple libraries, tests, and executables.</p>
 <h3><a id="conventional-cmake"></a> <a href="#contents">≡</a> <a href="#conventional-cmake"><code>conventional.cmake</code></a></h3>
+<p><a target="_blank" href="https://github.com/cppsm/cppsm-boilerplate/blob/master/conventional.cmake"><code>conventional.cmake</code> <i class="fas fa-xs fa-external-link-alt"></i></a>
+is a CMake script that (only) defines a number of CMake functions for targets
+and projects that adhere to the <a href="#project-structure">project structure</a>.</p>
 <h4><a id="add_conventional_executable"></a> <a href="#contents">≡</a> <a href="#add_conventional_executable"><code>add_conventional_executable(name)</code></a></h4>
 <p>Adds an executable target with the given name. Assumes that the target directory
 has implementation files matching the pattern <code>program/*.{cpp,hpp}</code>.</p>
diff --git a/index.md b/index.md
@@ -369,6 +369,10 @@ CMake boilerplate is provided for simple libraries, tests, and executables.
 
 ### <a id="conventional-cmake"></a> [≡](#contents) [`conventional.cmake`](#conventional-cmake)
 
+[`conventional.cmake`](https://github.com/cppsm/cppsm-boilerplate/blob/master/conventional.cmake)
+is a CMake script that (only) defines a number of CMake functions for targets
+and projects that adhere to the [project structure](#project-structure).
+
 #### <a id="add_conventional_executable"></a> [≡](#contents) [`add_conventional_executable(name)`](#add_conventional_executable)
 
 Adds an executable target with the given name. Assumes that the target directory
