From c92a87301cfc71e242f7a618cc6bdd3a891de1e1 Mon Sep 17 00:00:00 2001
From: Joscha Schmiedt <schmiedt@uni-bremen.de>
Date: Wed, 21 Aug 2024 10:21:34 +0200
Subject: [PATCH] DOC: Clarify that vcpkg is optional and unsupported
---
doc/Install_develop.rst | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/doc/Install_develop.rst b/doc/Install_develop.rst
index f7dd3f1..38d55b8 100644
--- a/doc/Install_develop.rst
+++ b/doc/Install_develop.rst
@@ -51,15 +51,17 @@ If you want to build or install libcaosdb without the use of Conan, feel
free to rewrite the CMakeLists.txt as needed. The CaosDB project is open
to merge requests which support multiple ways of installation.
-Building with ``vcpkg``
-~~~~~~~~~~~~~~~~~~~~~~~
+Optional: Building with ``vcpkg``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Instead of Conan, you can use the vcpkg package manager to install the dependencies (`vcpkg.json`). It's included as
-a submodule in the project. To install the dependencies, run the following commands:
+Next to Conan, you also have the option to use the vcpkg package manager to install the
+dependencies (`vcpkg.json`). Note, however, *vcpkg is not fully supported and tested*. It's
+included as a submodule in the project. To install the dependencies, run the following
+commands:
.. code:: console
- ./vcpkg/bootstrap-vcpkg.<sh/bat>
+ ./vcpkg/bootstrap-vcpkg.<sh/bat> -disableMetrics
vcpkg/vcpkg install
--
GitLab