Skip to content

Commit ee5232f

Browse files
author
MarkusB
committed
docs: update usage instructions for new library setup
Clarified steps for copying template files and added details on adding `devenv` as a submodule.
1 parent a3583e5 commit ee5232f

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,14 @@ Then `pre-commit` runs on commit; you can also run `pre-commit run -a` manually.
4646
## Usage when starting a new library
4747

4848
1. Create your new repo (e.g. on GitHub).
49-
2. Copy everything from this template.
50-
3. Rename namespace and library name everywhere. See the top comment in `CMakeLists.txt` for what to change:
49+
2. Copy everything except devenv, .git, and similar, from this template.
50+
3. Add https://github.com/devmarkusb/devenv as submodul, cf. README.md there.
51+
4. Rename namespace and library names everywhere. See the top comment in `CMakeLists.txt` for what to change:
5152
- `MB_CPP_LIB_TEMPLATE` (CMake option prefix)
5253
- `cpp-lib-template` (project and target names)
5354
- `mb.` / `mb::` / `mb/` (namespace and install layout)
54-
4. Go. When you find improvements that belong in the template, consider contributing them back here.
55+
- files and dirs
56+
5. Go. When you find improvements that belong in the template, consider contributing them back here.
5557

5658
## CMake options
5759

0 commit comments

Comments
 (0)