aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJan HrubĂ˝ <jhruby.web@gmail.com>2017-03-13 08:56:05 +0100
committerGitHub <noreply@github.com>2017-03-13 08:56:05 +0100
commit665f4118f603c5858217ed7a2f2f824b18ff4fc5 (patch)
treef0167041edf71e90f2331b5025f603392a8de67a /README.md
parent1bec0fcb73073b5b1719f454c368a63f1bff625e (diff)
parent1c9873a0daf625f67474aaf3e163c592c27ecb65 (diff)
downloadvcpkg-665f4118f603c5858217ed7a2f2f824b18ff4fc5.tar.gz
vcpkg-665f4118f603c5858217ed7a2f2f824b18ff4fc5.zip
Merge pull request #1 from Microsoft/master
pull
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1a34c1c4a..911ad0e56 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,13 @@ Vcpkg helps you get C and C++ libraries on Windows. This tool and ecosystem are
For short description of available commands, run `vcpkg help`.
## Quick Start
-If there is no `vcpkg.exe` (such as after a `git clone`), run
+Prerequisites:
+- Visual Studio 2015 Update 3 or
+- Visual Studio 2017
+- CMake 3.8.0 or higher (note: downloaded automatically if not found)
+- `git.exe` available in your path
+
+Clone this repository, then run
```
C:\src\vcpkg> powershell -exec bypass scripts\bootstrap.ps1
```
@@ -18,12 +24,12 @@ Install any packages with
```
C:\src\vcpkg> .\vcpkg install sdl2 curl
```
-Finally, create a New Project (or open an existing one) in Visual Studio 2015. You can now `#include` and use any of the installed libraries.
+Finally, create a New Project (or open an existing one) in Visual Studio 2015 or Visual Studio 2017. You can now `#include` and use any of the installed libraries.
## Examples
See the [`docs\EXAMPLES.md`](docs/EXAMPLES.md) document for specific walkthroughs, including using a package and adding a new package.
-See a 4 mm [demo in video](https://www.youtube.com/watch?v=y41WFKbQFTw).
+See a 4 minute [demo in video](https://www.youtube.com/watch?v=y41WFKbQFTw).
## Contributing
Vcpkg is built with your contributions. Here are some ways you can contribute:
@@ -31,7 +37,7 @@ Vcpkg is built with your contributions. Here are some ways you can contribute:
* [Submit Issues](https://github.com/Microsoft/vcpkg/issues) in vcpkg or existing packages
* [Submit Fixes and New Packages](https://github.com/Microsoft/vcpkg/pulls)
-Please refer to our [Contribution guidelines](docs/CONTRIBUTING.md) for more details.
+Please refer to our [Contribution guidelines](CONTRIBUTING.md) for more details.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.