From 693989c7cef656285ac11841a785e00ab9043499 Mon Sep 17 00:00:00 2001 From: "Dr. Patrick Urbanke" Date: Tue, 18 Mar 2025 03:44:24 +0100 Subject: [PATCH] Added installation instructions --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index ec6bd85..619cd36 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,22 @@ if (result) { std::cout << result.error().what() << std::endl; } ``` + +## Installation + +To install vcpkg: + +``` +git submodule update --init +./vcpkg/bootstrap-vcpkg.sh # Linux, macOS +./vcpkg/bootstrap-vcpkg.bat # Windows +# You may be prompted to install additional dependencies. +``` + +To compile the library: + +``` +cmake -S . -B build -DCMAKE_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Release +cmake --build build -j 4 # gcc, clang +cmake --build build --config Release -j 4 # MSVC +```