Skip to content

Commit a47f477

Browse files
committed
docs: add usage
Signed-off-by: msclock <[email protected]>
1 parent 8c971ad commit a47f477

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# A cmake registry
22

33
This is a cmake modules registry based on vcpkg and accepts cmake module registration.
4+
5+
## Usage
6+
7+
Just register the cmake registry to the vcpkg configuration.
8+
9+
```json
10+
{
11+
"registries": [
12+
{
13+
"kind": "git",
14+
"baseline": "8c971ad168027d4c3acbd2b3a2752b80e0859fef",
15+
"repository": "https://github.com/msclock/cmake-registry",
16+
"packages": [
17+
"cmake-modules",
18+
"vcpkg-cmake-module"
19+
]
20+
}
21+
]
22+
}
23+
```
24+
Add the modules to vcpkg dependencies.
25+
26+
```json
27+
{
28+
"dependencies": [
29+
"cmake-modules"
30+
]
31+
}
32+
```
33+
34+
There is a real [example](https://github.com/msclock/cpp-scaffold) can refer.

0 commit comments

Comments
 (0)