diff options
| author | Robert Schumacher <roschuma@microsoft.com> | 2017-05-28 14:20:32 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-28 14:20:32 -0700 |
| commit | 39b69e5b06df309b9dcfea55296a4c2c3eea93ce (patch) | |
| tree | 6fcbc7ef1752c45270abfe21eabd5452876462d8 /README.md | |
| parent | e95a0986962405ab5b6e2da149462f04f199b2c8 (diff) | |
| parent | 49cd3995862c0bed0701f84535812e1d0690896f (diff) | |
| download | vcpkg-39b69e5b06df309b9dcfea55296a4c2c3eea93ce.tar.gz vcpkg-39b69e5b06df309b9dcfea55296a4c2c3eea93ce.zip | |
Merge pull request #1111 from Microsoft/docs
[vcpkg] Documentation revamp using MkDocs & readthedocs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 9 insertions, 7 deletions
@@ -7,10 +7,10 @@ For short description of available commands, run `vcpkg help`. ## Quick Start 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 +- Windows 10, 8.1, or 7 +- Visual Studio 2017 or Visual Studio 2015 Update 3 +- Git +- *Optional: CMake 3.8.0* Clone this repository, then run ``` @@ -24,12 +24,14 @@ 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 or Visual Studio 2017. You can now `#include` and use any of the installed libraries. +Finally, create a New Project (or open an existing one) in Visual Studio 2017 or 2015. All installed libraries are immediately ready to be `#include`'d and used in your project. + +For CMake projects, simply include our toolchain file. See our [using a package](docs/examples/using-sqlite.md) example for the specifics. ## Examples -See the [`docs\EXAMPLES.md`](docs/EXAMPLES.md) document for specific walkthroughs, including using a package and adding a new package. +See the [documentation](docs/index.md) for specific walkthroughs, including [using a package](docs/examples/using-sqlite.md) and [adding a new package](docs/examples/packaging-zlib.md). -See a 4 minute [demo in video](https://www.youtube.com/watch?v=y41WFKbQFTw). +See a 4 minute [video demo](https://www.youtube.com/watch?v=y41WFKbQFTw). ## Contributing Vcpkg is built with your contributions. Here are some ways you can contribute: |
