Skip to content

Add vcpkg installation instructions to README and docs #64

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
hzhangxyz merged 3 commits into from
Dec 3, 2025
Merged

Add vcpkg installation instructions to README and docs #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddc6bc8
Initial plan
Copilot Dec 3, 2025
0531482
Add vcpkg installation instructions to README and docs
Copilot Dec 3, 2025
19f867a
Simplify vcpkg docs: remove vcpkg-configuration.json section
Copilot Dec 3, 2025
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
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,32 @@ Requires Python 3.10-3.14.

The C++ library is the core implementation. Both Python and TypeScript bindings are built on top of it.

#### Using vcpkg

Clone the repository and use the overlay port:

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

Add to your `vcpkg.json`:

```json
{
"dependencies": ["ds"]
}
```

In your CMakeLists.txt:

```cmake
find_package(ds CONFIG REQUIRED)
target_link_libraries(your_target PRIVATE ds::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.
#### Building from Source

```bash
git clone https://github.com/USTC-KnowledgeComputingLab/ds.git
cd ds
Expand Down
24 changes: 24 additions & 0 deletions docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,30 @@ The C++ library is the core implementation. Both Python and TypeScript bindings
- C++20 compatible compiler (GCC 10+, Clang 10+, MSVC 2019+)
- CMake 3.30+

### Using vcpkg

Clone the repository and use the overlay port:

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

Add to your `vcpkg.json`:

```json
{
"dependencies": ["ds"]
}
```

In your CMakeLists.txt:

```cmake
find_package(ds CONFIG REQUIRED)
target_link_libraries(your_target PRIVATE ds::ds)
```

### Building from Source

```bash
Expand Down