Skip to content

Commit 0af7de3

Browse files
committed
Work on readmes
1 parent c875c21 commit 0af7de3

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ More generally, a new project should contain all core modules and, as needed, ad
5353

5454
# Non-Goals
5555

56-
In order to be usable in a deterministic, idiomatic fashion, we avoid the following approaches and features:
56+
In order to be usable in a deterministic, idiomatic fashion, cmake-init avoids the following approaches and features:
5757

5858
### Super-Build
5959

@@ -89,6 +89,29 @@ sources from the project tree.
8989

9090
### cmake-init Template Check
9191

92+
This module allows to check the actuality of the used cmake-init template for own projects.
93+
This module is usable when the following is integrated into the `CMakeLists.txt`.
94+
95+
```cmake
96+
# Add cmake-init template check cmake targets
97+
add_check_template_target(<CMAKE_INIT_SHA>)
98+
```
99+
100+
Here, the `<CMAKE_INIT_SHA>` contains the git hash of the used cmake-init template.
101+
Further, the files `cmake/HealthCheck.cmake` and `cmake/CheckTemplate.cmake` are required.
102+
103+
The hash is usually configured using
104+
105+
```cmake
106+
# Meta information about the project
107+
set(META_CMAKE_INIT_SHA "<CMAKE_INIT_SHA>")
108+
109+
# Add cmake-init template check cmake targets
110+
add_check_template_target(<CMAKE_INIT_SHA>)
111+
```
112+
113+
Correctly configures, this module adds a cmake build target named `check-template` that compares the passed `<CMAKE_INIT_SHA>` with the current master commit hash of this repository and provides a link for a diff view.
114+
92115
## Development Modules
93116

94117
### Build Targets

0 commit comments

Comments
 (0)