Skip to content

Commit

Permalink
[vcpkg-docs] Rework documentation for compatibility with readthedocs.…
Browse files Browse the repository at this point in the history
…io and MkDocs.
  • Loading branch information
ras0219-msft committed May 28, 2017
1 parent e95a098 commit 49cd399
Show file tree
Hide file tree
Showing 39 changed files with 1,577 additions and 465 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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:
Expand Down
302 changes: 0 additions & 302 deletions docs/EXAMPLES.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/ROADMAP.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
theme: jekyll-theme-minimal
theme: jekyll-theme-cayman
Loading

0 comments on commit 49cd399

Please sign in to comment.