Skip to content

Add vcpkg installation instructions to README and docs - #64

Merged
hzhangxyz merged 3 commits into
mainfrom
copilot/update-installation-docs
Dec 3, 2025
Merged

Add vcpkg installation instructions to README and docs#64
hzhangxyz merged 3 commits into
mainfrom
copilot/update-installation-docs

Conversation

Copilot AI commented Dec 3, 2025

Copy link
Copy Markdown
Contributor

Syncs documentation with the recently added vcpkg configuration in ports/ds/.

Changes

  • README.md: Added vcpkg section under C++ installation with overlay port usage, vcpkg.json example, and CMake integration
  • docs/getting-started/installation.md: Added vcpkg section with overlay port setup, vcpkg.json example, and CMake integration

Usage

git clone https://github.com/USTC-KnowledgeComputingLab/ds.git
vcpkg install ds --overlay-ports=./ds/ports

Add to your vcpkg.json:

{
  "dependencies": ["ds"]
}

CMake integration:

find_package(ds CONFIG REQUIRED)
target_link_libraries(your_target PRIVATE ds::ds)
Original prompt

This section details on the original issue you should resolve

<issue_title>vcpkg的配置刚刚添加, 需同步README和docs中的Installation部分.</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README and docs for vcpkg installation Add vcpkg installation instructions to README and docs Dec 3, 2025
Copilot AI requested a review from hzhangxyz December 3, 2025 04:29
@hzhangxyz
hzhangxyz marked this pull request as ready for review December 3, 2025 04:29
Copilot AI review requested due to automatic review settings December 3, 2025 04:29

@hzhangxyz hzhangxyz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

去掉

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)

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
"dependencies": ["ds"]
}
```

Copilot AI Dec 3, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
#### 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)

Copilot uses AI. Check for mistakes.
Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com>

Copilot AI commented Dec 3, 2025

Copy link
Copy Markdown
Contributor Author

去掉

Or configure in `vcpkg-configuration.json`:...

Done in 19f867a. Removed the vcpkg-configuration.json section from both files, kept the vcpkg install command followed by vcpkg.json dependencies and CMake integration (find_package and target_link_libraries).

Copilot AI requested a review from hzhangxyz December 3, 2025 04:34
@hzhangxyz
hzhangxyz merged commit 1f2de5c into main Dec 3, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

vcpkg的配置刚刚添加, 需同步README和docs中的Installation部分.

3 participants