From 774643ee177e3aa588421d4d313ca65369c3554c Mon Sep 17 00:00:00 2001 From: Archie Jaskowicz Date: Sat, 9 Sep 2023 18:20:46 +0100 Subject: [PATCH] docs: refactored install-vcpkg.md (#849) Co-authored-by: Jakub 'Eremiell' Marek --- docpages/install/install-vcpkg.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docpages/install/install-vcpkg.md b/docpages/install/install-vcpkg.md index f7f44629f1..8ffcb00d78 100644 --- a/docpages/install/install-vcpkg.md +++ b/docpages/install/install-vcpkg.md @@ -1,19 +1,22 @@ -\page install-vcpkg Installing from VCPKG (Windows, Linux, OSX) +\page install-vcpkg Installing from VCPKG (Windows) -To install D++ on a system from VCPKG: +\warning **We do not support VCPKG for any platform that isn't Windows. This does not mean VCPKG doesn't work, it just means we do not test it.** If you are using other platforms then please look towards our other pages. We also advise that you use the [pre-made Visual Studio template](https://github.com/brainboxdotcc/windows-bot-template/) on Windows, as VCPKG takes longer to receive updates. + +To install D++ on a system with VCPKG: + +- Ensure VCPKG is correctly installed, and run `vcpkg integrate install` to integrate it with your preferred IDE. This has been reported to work with Visual Studio, VSCode, and JetBrains CLion. +- From a command line, type `vcpkg install dpp:x64-windows` -- Ensure VCPKG is correctly installed, and run `vcpkg integrate install` to integrate it with your preferred IDE. This has been reported to work with Visual Studio, vscode, and JetBrains CLion. -- From a command line, type `vcpkg install dpp:x64-windows` (replace `x64-windows` with whichever OS and architecture you want the library to be built for) \image html vcpkg.png -- VCPKG will install the library and dependencies for you! Once completed you will receive a message indicating success: -- Use `vcpkg list dpp` to check that the package is installed: -``` +- VCPKG will install the library, and dependencies, for you! Once completed, you will receive a message, indicating that dpp successfully installed! +- Use `vcpkg list dpp` to check that the package is installed, as so: +```cmd c:\vcpkg>vcpkg list dpp -dpp:x64-windows 10.0.15 D++ Extremely Lightweight C++ Discord Library. +dpp:x64-windows 10.0.24 D++ Extremely Lightweight C++ Discord Library. ``` - You may now use the library within a `CMake` based project by adding instructions such as these to your `CMakeLists.txt`: ```cmake - find_package(dpp CONFIG REQUIRED) - target_link_libraries(your_target_name PRIVATE dpp::dpp) +find_package(dpp CONFIG REQUIRED) +target_link_libraries(your_target_name PRIVATE dpp::dpp) ```