Skip to content

Commit a86d338

Browse files
committed
Work on README.md
1 parent 0c9af66 commit a86d338

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,17 @@ The main target platforms are typical desktop, laptop, and server platforms. Cur
1818
* macOS
1919
* GNU/Linux
2020

21+
However, other UNIX versions may work as well if they are supported by CMake.
22+
2123
The cmake-init template assumes you want to setup a project using
2224
* CMake (3.0 or above)
2325
* C/C++ compiler
2426

2527

2628
# Contents
2729

28-
* [Adaption Guide](#adaption-guide)
30+
* [Usage](#usage)
31+
* [Adaption Guide](#adaption-guide)
2932
* [Non-Goals](#non-goals)
3033
* [Module Documentation](#module-documentation)
3134
* [Core Modules](#core-modules)
@@ -46,10 +49,24 @@ The cmake-init template assumes you want to setup a project using
4649
* [Packaging](#packaging)
4750
* [Run-time Assets](#run-time-assets)
4851

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+
5069

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.
5370

5471
# Non-Goals
5572

0 commit comments

Comments
 (0)