Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refactored install-vcpkg.md #849

Merged
merged 1 commit into from
Sep 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)
```