-
Notifications
You must be signed in to change notification settings - Fork 543
As requested, add detailed installation instructions for Vcpkg and Conan #1031
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
As requested, add detailed installation instructions for Vcpkg and Conan #1031
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, added a suggestion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with one suggested change.
You can find the header files in: | ||
``` | ||
vcpkg/installed/<CPU ARCHITECTURE>-<OPERATING SYSTEM>/include/ | ||
``` | ||
|
||
The library files are in: | ||
``` | ||
vcpkg/installed/<CPU ARCHITECTURE>-<OPERATING SYSTEM>/lib/ | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vcpkg recommends using the vcpkg.cmake
pre-include file for CMake projects, and prefers the new "manifest mode" when possible. I would note both of those here with external documentation links.
vcpkg/installed/<CPU ARCHITECTURE>-<OPERATING SYSTEM>/lib/ | ||
``` | ||
|
||
### Conan Install Instructions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Include an up-front notice hat the package specifier is mongo-cxx-driver/<version>
. More advanced Conan users will look for this information specifically. Same recommendation for the vcpkg section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. I added the following line for the Conan documentation, but since Vcpkg handles versioning entirely through git, what is your recommendation for Vcpkg?
Package Specifier: `mongo-cxx-driver/3.8.0`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For vcpkg, just the package name is enough for anyone to get started quickly. Maybe leave a note that the version may be out of date on older vcpkg versions.
|
||
### Conan Install Instructions | ||
|
||
Package Specifier: `mongo-cxx-driver/3.8.0` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3.8.1 is now available (as of yesterday)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I currently have a PR open with Conan to update their version to 3.8.1. I'll update the version in the instructions once it gets merged: conan-io/conan-center-index#20504
CXX-2623
CXX-2759