From ddc6bc8d28d6fa4524702707e9bbfe02c7df8d68 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 3 Dec 2025 04:24:51 +0000 Subject: [PATCH 1/3] Initial plan From 0531482db5f983cec89f2ada614dd06bee50eb14 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 3 Dec 2025 04:27:59 +0000 Subject: [PATCH 2/3] Add vcpkg installation instructions to README and docs Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com> --- README.md | 27 +++++++++++++++++++++++ docs/getting-started/installation.md | 32 ++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) diff --git a/README.md b/README.md index e271e26..caef4e2 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,33 @@ 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 +``` + +Or configure in `vcpkg-configuration.json`: + +```json +{ + "overlay-ports": ["./ds/ports"] +} +``` + +Then add to your `vcpkg.json`: + +```json +{ + "dependencies": ["ds"] +} +``` + +#### Building from Source + ```bash git clone https://github.com/USTC-KnowledgeComputingLab/ds.git cd ds diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 5549eb3..d30fb6d 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -75,6 +75,38 @@ 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 +``` + +Or configure in `vcpkg-configuration.json`: + +```json +{ + "overlay-ports": ["./ds/ports"] +} +``` + +Then 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 From 19f867a38433c5d2d107776f5574f293e806d852 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 3 Dec 2025 04:33:07 +0000 Subject: [PATCH 3/3] Simplify vcpkg docs: remove vcpkg-configuration.json section Co-authored-by: hzhangxyz <11623447+hzhangxyz@users.noreply.github.com> --- README.md | 13 ++++++------- docs/getting-started/installation.md | 10 +--------- 2 files changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index caef4e2..cffd282 100644 --- a/README.md +++ b/README.md @@ -53,20 +53,19 @@ git clone https://github.com/USTC-KnowledgeComputingLab/ds.git vcpkg install ds --overlay-ports=./ds/ports ``` -Or configure in `vcpkg-configuration.json`: +Add to your `vcpkg.json`: ```json { - "overlay-ports": ["./ds/ports"] + "dependencies": ["ds"] } ``` -Then add to your `vcpkg.json`: +In your CMakeLists.txt: -```json -{ - "dependencies": ["ds"] -} +```cmake +find_package(ds CONFIG REQUIRED) +target_link_libraries(your_target PRIVATE ds::ds) ``` #### Building from Source diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index d30fb6d..d6bb655 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -84,15 +84,7 @@ git clone https://github.com/USTC-KnowledgeComputingLab/ds.git vcpkg install ds --overlay-ports=./ds/ports ``` -Or configure in `vcpkg-configuration.json`: - -```json -{ - "overlay-ports": ["./ds/ports"] -} -``` - -Then add to your `vcpkg.json`: +Add to your `vcpkg.json`: ```json {