Skip to content

Commit c7e80f4

Browse files
committed
Improve readme documentation
1 parent 276fce9 commit c7e80f4

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ features:
77
* Use of a "dry-run" build to generate a unique cache key for the configuration.
88
* Optionally supports reading `vcpkg.json` manifest files
99

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

1313
```
1414
-DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=<triplet> -DVCPKG_MANIFEST_MODE=OFF
@@ -112,3 +112,17 @@ jobs:
112112
token: ${{ github.token }}
113113
```
114114
115+
## Hints
116+
117+
* Use the `--x-feature=...` option with `extra-args` to enable manifest mode features.
118+
* Use the `--x-buildtrees-root=...` option with `extra-args` to move the build trees out of the github workspace if path length errors occur.
119+
* Use the `--clean-after-build` option with `extra-args` to reduce disk space usage for large projects.
120+
121+
When using manifest mode, it is recommended to check out your source to a subdirectory to prevent vcpkg from
122+
detecting your `vcpkg.json` file. This action overrides the default behavior to provide caching. For example:
123+
124+
```yaml
125+
- uses: actions/checkout@v6
126+
with:
127+
path: my_src
128+
```

0 commit comments

Comments
 (0)