Skip to content

Commit 702fb33

Browse files
committed
Document the -p flag in the README
1 parent 05bfbfb commit 702fb33

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ Make sure you have these programs installed:
9797
* [LCOV](#lcov) (optional)
9898
* [clang-format 11](#clang-format) (optional)
9999
* [codespell](#codespell) (optional)
100+
* [Package managers](#package-managers): Conan or vcpkg (optional)
100101

101102
---
102103
**NOTE**
@@ -202,6 +203,24 @@ code.
202203
Two targets are made available to check and fix spelling errors in developer
203204
mode using the `spell-check` and `spell-fix` targets respectively.
204205

206+
### Package managers
207+
208+
The `-p` flag can be used to select a package manager for the project.
209+
Arguments for the flag can be:
210+
211+
* `none`: no package manager integration (default)
212+
* `conan`: [Conan][21] integration
213+
* `vcpkg`: [vcpkg][22] integration
214+
215+
When using a package manager, the following packages are used in the generated
216+
project:
217+
218+
* [fmt][23] for C++ and [json-c][24] for C projects
219+
* [Catch2][25] as a dev dependency for C++ and C projects
220+
221+
Make sure to read the generated HACKING document to see what needs to be done
222+
to fetch dependencies.
223+
205224
## Usage
206225

207226
* `cmake-init [--c] <path>`
@@ -254,3 +273,8 @@ indirectly from the use or non-use of these files.
254273
[18]: https://github.com/friendlyanon/cmake-init/wiki/Examples
255274
[19]: https://github.com/friendlyanon/cmake-init/issues/41
256275
[20]: https://github.com/friendlyanon/cmake-init/issues/48
276+
[21]: https://conan.io/
277+
[22]: https://github.com/microsoft/vcpkg
278+
[23]: https://github.com/fmtlib/fmt
279+
[24]: https://github.com/json-c/json-c
280+
[25]: https://github.com/catchorg/Catch2

0 commit comments

Comments
 (0)