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

Add vcpkg installation instructions #116

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
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
13 changes: 13 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,17 @@ autoreconf -vfi

./configure && make && make install

Building enet -use vcpkg

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


You can download and install enet using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
vcpkg install enet

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


The enet port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.