Skip to content

Improve readme documentation #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnwason merged 1 commit into from
May 4, 2026
Merged

Improve readme documentation #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ features:
* Use of a "dry-run" build to generate a unique cache key for the configuration.
* Optionally supports reading `vcpkg.json` manifest files

`vcpkg` is cloned to the `${{ github.workspace }}\vcpkg` directory, and the build products are located in
`${{ github.workspace }}\vcpkg\installed\<triplet>`. For cmake, use the option:
`vcpkg` is cloned to the `${{ github.workspace }}/vcpkg` directory, and the build products are located in
`${{ github.workspace }}/vcpkg/installed/<triplet>`. For cmake, use the option:

```
-DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=<triplet> -DVCPKG_MANIFEST_MODE=OFF
Expand Down Expand Up @@ -112,3 +112,17 @@ jobs:
token: ${{ github.token }}
```

## Hints

* Use the `--x-feature=...` option with `extra-args` to enable manifest mode features.
* Use the `--x-buildtrees-root=...` option with `extra-args` to move the build trees out of the github workspace if path length errors occur.
* Use the `--clean-after-build` option with `extra-args` to reduce disk space usage for large projects.

When using manifest mode, it is recommended to check out your source to a subdirectory to prevent vcpkg from
detecting your `vcpkg.json` file. This action overrides the default behavior to provide caching. For example:

```yaml
- uses: actions/checkout@v6
with:
path: my_src
```
Loading