You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-4Lines changed: 21 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,14 +18,17 @@ The main target platforms are typical desktop, laptop, and server platforms. Cur
18
18
* macOS
19
19
* GNU/Linux
20
20
21
+
However, other UNIX versions may work as well if they are supported by CMake.
22
+
21
23
The cmake-init template assumes you want to setup a project using
22
24
* CMake (3.0 or above)
23
25
* C/C++ compiler
24
26
25
27
26
28
# Contents
27
29
28
-
*[Adaption Guide](#adaption-guide)
30
+
*[Usage](#usage)
31
+
*[Adaption Guide](#adaption-guide)
29
32
*[Non-Goals](#non-goals)
30
33
*[Module Documentation](#module-documentation)
31
34
*[Core Modules](#core-modules)
@@ -46,10 +49,24 @@ The cmake-init template assumes you want to setup a project using
46
49
*[Packaging](#packaging)
47
50
*[Run-time Assets](#run-time-assets)
48
51
49
-
# Adaption Guide
52
+
# Usage
53
+
54
+
The intended use of the template is a copy of the current version with a subsequent replacement of project names and customization of modules to your needs. This is documented within the [adaption guide](#adaption-guide).
55
+
Another approach is the initialization of a new CMake project where the required features are adopted from cmake-init. We propose the former workflow.
56
+
57
+
Concluding, a new project should contain the core modules and, as needed, add the maintainer and development modules as required. All modules are designed in a way that they can be excluded. The process of integration or removal of a module/feature is documented with each module.
58
+
59
+
## Adaption Guide
60
+
61
+
The file [ADAPT.md](https://github.com/cginternals/cmake-init/blob/master/ADAPT.md) contains a task checklist for new projects. Your start with a copy of cmake-init and process each item from the checklist, adjusting the template to your needs.
62
+
63
+
## Update
64
+
65
+
After some time working on a project, cmake-init may be updated and you want to integrate the changes.
66
+
For an overview of changes we suggest to use the [cmake-init Template Check](#cmake-init-template-check) module.
67
+
Alternatively, you can update the required modules selectively.
68
+
50
69
51
-
The file [ADAPT.md](https://github.com/cginternals/cmake-init/blob/master/ADAPT.md) contains a task checklist for new projects.
52
-
More generally, a new project should contain all core modules and, as needed, add the maintainer and development modules as required. cmake-init does not impose modularity rules for the cmake targets.
0 commit comments