From 3df261b15b545ec7c71c426ea8f2ea1340fc618a Mon Sep 17 00:00:00 2001
From: Joscha Schmiedt <joscha@schmiedt.dev>
Date: Fri, 9 Aug 2024 22:03:07 +0200
Subject: [PATCH] DOC: Add basic compilation steps with vcpkg
(not functional yet, only how it should work later on)
---
doc/Install_develop.rst | 23 ++++++++++++++++++++++-
1 file changed, 22 insertions(+), 1 deletion(-)
diff --git a/doc/Install_develop.rst b/doc/Install_develop.rst
index 67618dc..d981c5e 100644
--- a/doc/Install_develop.rst
+++ b/doc/Install_develop.rst
@@ -19,6 +19,27 @@ which have ``make`` installed, type this in your command line terminal:
make conan
+Building with ``vcpkg``
+~~~~~~~~~~~~~~~~~~~~~~~
+
+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:
+
+.. code:: console
+
+ ./vcpkg/bootstrap-vcpkg.<sh/bat>
+ vcpkg/vcpkg install
+
+
+Then compile the project with CMake by including the vcpkg toolchain file:
+
+.. code:: console
+
+ cd build
+ cmake -S .. -B . -DCMAKE_TOOLCHAIN_FILE=../vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-linux
+ cmake --build .
+
+
Manual build
~~~~~~~~~~~~
@@ -74,7 +95,7 @@ as compiler. We use `cmake <https://cmake.org/download/>`__ as build
tool.
1. clone/update the subrepo ``git submodule update --init proto``
-2. ``conan install .. -g visual_studio -s arch=x86_64 -s build_type=Release -s compiler.toolset=v142 -s compiler.version=16 -s compiler.runtime=MD --build=missing --update``
+2. :code:``conan install .. -g visual_studio -s arch=x86_64 -s build_type=Release -s compiler.toolset=v142 -s compiler.version=16 -s compiler.runtime=MD --build=missing --update``
3. ``cd build/Release``
5. ``cmake -B . ..``
6. open ``libcaosdb.sln`` with Visual Studio, change the buildtype to
--
GitLab