Skip to content

Commit 6ecebab

Browse files
authored
Add common vcpkg commands to README
1 parent 51db714 commit 6ecebab

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,36 @@ The version of each dependency is influenced by the git checkout of vcpkg, conta
125125

126126
See [here](https://github.com/microsoft/vcpkg/blob/master/docs/examples/packaging-github-repos.md) for how to package a new library.
127127

128+
## Useful manual vcpkg commands
129+
130+
Sometimes it is useful to run vcpkg commands manually for testing a single package. Ideally, someone who wants to do this would read the [vcpkg documentation](https://github.com/microsoft/vcpkg/tree/master/docs), but below we list some commonly used commands.
131+
132+
The following commands should be run from the root of this repo, and they do not apply if you have downloaded pre-built packages.
133+
134+
### Installing
135+
136+
Remember, you must know the triplet you would like to build with if you are using an existing installation after running the build script.
137+
138+
```sh
139+
./vcpkg/vcpkg install --triplet=x64-osx-rel @overlays.txt --debug grpc
140+
```
141+
142+
This command will
143+
* `install` the `grpc` package
144+
* using the `x64-osx-rel` triplet to only build x86-64 Release builds for Mac
145+
* in the context of `@overlays.txt`, which sets up vcpkg package paths using normal vcpkg commands (look at the file if you're interested)
146+
* and tell vcpkg to print out `--debug` information
147+
148+
### Uninstalling
149+
150+
Remember, you must know the triplet you would like to build with if you are using an existing installation after running the build script.
151+
152+
```sh
153+
./vcpkg/vcpkg remove --triplet=x64-osx-rel @overlays.txt --debug grpc
154+
```
155+
156+
This command will do similar things as the above command, except it will `remove` the package from the installation directory instead of installing.
157+
128158
## LICENSING
129159

130160
This repo is under the Apache-2.0 LICENSE, unless where specified. See below.

0 commit comments

Comments
 (0)