Skip to content

Commit 0af1dcc

Browse files
committed
enh: Change title of help page to 'Support', minor CMake modules README edits
1 parent 27b2ad6 commit 0af1dcc

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

README.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,8 @@ complete [CMake BASIS project][3].
1313
License
1414
=======
1515

16-
Copyright 2011-2013 University of Pennsylvania <br />
17-
Copyright 2013-2016 Andreas Schuh <br />
18-
Copyright 2013-2014 Carnegie Mellon University
19-
20-
CMake BASIS Modules are distributed under the OSI-approved BSD License (the "License");
21-
see accompanying file [COPYING.txt](/COPYING.txt) for details.
16+
The CMake BASIS Modules are distributed under the OSI-approved BSD License.
17+
See accompanying file [COPYING.txt](/COPYING.txt) for details.
2218

2319
This software is distributed WITHOUT ANY WARRANTY; without even the
2420
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
@@ -32,32 +28,32 @@ Developers requiring only the CMake BASIS Modules are encouraged to include the
3228
[CMake BASIS Modules][2] files directly in their own Git controlled project source
3329
tree, either as Git subtree or (shallow) submodule.
3430

35-
To utilize these modules, we recommend the use of the `basis-modules` project
36-
template instead of the `basis` template which requires a separate build of
37-
the entire [CMake BASIS project][3].
31+
To only utilize these modules, we recommend the use of the `basis-modules`
32+
project template instead of the `basis` template which requires a separate
33+
build of the entire [CMake BASIS project][3].
3834

39-
**TODO**: Add template files to CMake BASIS and link them here.
35+
**TODO**: Add `basis-modules` project template to CMake BASIS and link them here.
4036

4137

4238
Using CMake modules as subtree (recommended)
4339
--------------------------------------------
4440

45-
To add the CMake BASIS Modules as subtree to your project under the subdirectory path `basis/`,
46-
use the following two commands. The first adds a new remote which simplifies the following
47-
commands:
41+
To add the CMake BASIS Modules as subtree to your project under the subdirectory
42+
path `basis/`, use the following two commands. The first adds a new remote which
43+
simplifies the consecutive commands:
4844

4945
```bash
50-
git remote add -f cmake-basis-modules https://github.com/cmake-basis/modules.git
51-
git subtree add --prefix=basis cmake-basis-modules master --squash
46+
git remote add -f basis-modules https://github.com/cmake-basis/modules.git
47+
git subtree add --prefix=basis basis-modules master --squash
5248
```
5349

54-
In order to update the modules at a later date to incorporate changes of the CMake
55-
BASIS Modules into your project, use the following commands:
50+
In order to update the modules at a later time to incorporate changes of
51+
the CMake BASIS Modules into your project, use the following commands:
5652

5753

5854
```bash
59-
git fetch cmake-basis-modules master
60-
git subtree pull --prefix=basis cmake-basis-modules master --squash
55+
git fetch basis-modules master
56+
git subtree pull --prefix=basis basis-modules master --squash
6157
```
6258

6359

@@ -68,18 +64,18 @@ An alternative to the `git subtree` command to add the CMake BASIS Modules to
6864
your project, you can use `git submodule` instead. For a comparison of the two
6965
commands and their ups and downs, read some of the many tutorials available online.
7066

71-
To add the CMake BASIS Modules as submodule to your project under the subdirectory path `basis/`,
72-
use the following commands. The `.gitmodules` file which records the added submodules
73-
and the URL of the remote repository must be committed to your project.
67+
To add the CMake BASIS Modules as submodule to your project under the subdirectory
68+
path `basis/`, use the following commands. The `.gitmodules` file which records the
69+
added submodules and the URL of the remote repository must be committed to your project.
7470

7571
```bash
7672
git submodule add --depth=1 https://github.com/cmake-basis/modules.git basis
7773
git add .gitmodules
7874
git commit -m 'add: CMake BASIS Modules'
7975
```
8076

81-
In order to update the modules at a later date to incorporate changes of the CMake
82-
BASIS Modules into your project, use the following commands:
77+
In order to update the modules at a later time to incorporate changes of the
78+
CMake BASIS Modules into your project, use the following commands:
8379

8480
```bash
8581
cd basis/ # change to submodule directory

0 commit comments

Comments
 (0)