Add vcpkg installation instructions to README and docs - #64
Conversation
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
hzhangxyz
left a comment
There was a problem hiding this comment.
去掉
Or configure in `vcpkg-configuration.json`:
{
"overlay-ports": ["./ds/ports"]
}
这个介绍, vcpkg install 后直接说将 dependencies: [ds] 加到 vcpkg.json 中, 以及后面的
find_package(ds CONFIG REQUIRED)
target_link_libraries(your_target PRIVATE ds::ds)
There was a problem hiding this comment.
Pull request overview
This PR adds vcpkg installation instructions to both the README and documentation, synchronizing them with the recently added vcpkg configuration in ports/ds/.
- Adds vcpkg installation section with overlay port usage and vcpkg.json configuration examples
- Documents CMake integration pattern for consuming the installed package (in docs only)
- Provides two installation approaches: command-line overlay and vcpkg-configuration.json
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds vcpkg installation section under C++ installation with overlay port setup and vcpkg.json example |
| docs/getting-started/installation.md | Adds comprehensive vcpkg section including overlay port setup, vcpkg-configuration.json, vcpkg.json usage, and CMake integration example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "dependencies": ["ds"] | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The vcpkg section in README.md is missing the CMake integration example that is present in the documentation file (installation.md). Users reading the README would benefit from seeing the complete usage pattern including find_package(ds CONFIG REQUIRED) and target_link_libraries(your_target PRIVATE ds::ds), as this shows how to actually use the installed package in their projects.
| #### CMake Integration Example | |
| After installing with vcpkg, you can use the library in your CMake project as follows: | |
| ```cmake | |
| find_package(ds CONFIG REQUIRED) | |
| target_link_libraries(your_target PRIVATE ds::ds) |
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Done in 19f867a. Removed the |
Syncs documentation with the recently added vcpkg configuration in
ports/ds/.Changes
Usage
Add to your
vcpkg.json:{ "dependencies": ["ds"] }CMake integration:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.