Add vcpkg installation instructions #116
Conversation
README
Outdated
| @@ -12,4 +12,17 @@ autoreconf -vfi | |||
|
|
|||
| ./configure && make && make install | |||
|
|
|||
| Building enet -use vcpkg | |||
There was a problem hiding this comment.
This feels like it should be a headline. The wording is also weird: -use vcpkg?
I also feel like this should be "Installing enet (vcpkg)" because it doesn't just build it - it also sort-of adds it to an index / central location.
README
Outdated
| cd vcpkg | ||
| ./bootstrap-vcpkg.sh | ||
| ./vcpkg integrate install | ||
| vcpkg install enet |
There was a problem hiding this comment.
The existing command line above is not indented. This file currently isn't real markdown.
I feel like it should be renamed to README.md and the other issues should be fixed first, OR, you should keep changes to plain text.
README
Outdated
| @@ -12,4 +12,17 @@ autoreconf -vfi | |||
|
|
|||
| ./configure && make && make install | |||
|
|
|||
| Building enet -use vcpkg | |||
There was a problem hiding this comment.
This section should be clearly marked as alternative option. It currently feels like this is a mandatory step after (or part of) compiling and installing the library.
|
I feel like this should be a separate markdown file "How to Install ENet" or something like this. Vcpkg is not the only way and when one gets promoted it is only natural that others want to get added to it too. For example, personally, I would like to see instructions for installing it with Conan |
|
Hi JayFoxRox, Thanks for your review and suggestion. Any suggestion is welcome. Thanks again, |
|
There doesn't seem to be anything special about installing Enet through vcpkg, so why it is even worth mentioning at all? Like @Croydon pointed out, when this is worth mentioning then we'd also want to mention how to install ENet on all the different Linux distributions, macOS, etc. But is it really worth it, given that those installation instructions are already documented more generally elsewhere? I guess that for discoverability a plain list of links to various packages could be maintained, like:
(of course, the list would become rather long if we included Linux distributions...) |
enetis available as a port in vcpkg, a C++ library manager that simplifies installation for enet and other project dependencies. Documenting the install process here will help users get started by providing a single set of commands to build enet, ready to be included in their projects.We also test whether our library ports build in various configurations (dynamic, static) on various platforms (OSX, Linux, Windows: x86, x64) to keep a wide coverage for users.
I'm a maintainer for vcpkg, and here is what the port script looks like. We try to keep the library maintained as close as possible to the original library.