Skip to content

Commit

Permalink
docs: refactored install-vcpkg.md (brainboxdotcc#849)
Browse files Browse the repository at this point in the history
Co-authored-by: Jakub 'Eremiell' Marek <[email protected]>
  • Loading branch information
2 people authored and Mishura4 committed Sep 17, 2023
1 parent bf05ca2 commit 774643e
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions docpages/install/install-vcpkg.md
Original file line number Diff line number Diff line change
@@ -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)
```

0 comments on commit 774643e

Please sign in to comment.