aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Karatarakis <alkarata@microsoft.com>2016-09-18 20:50:08 -0700
committerAlexander Karatarakis <alkarata@microsoft.com>2016-09-18 20:54:03 -0700
commitccca198c1b1730b0241911cb56dc8e3504958b2a (patch)
treea2dd9b8b087a09afdcecc5cbb3377bed15127eb2 /README.md
downloadvcpkg-ccca198c1b1730b0241911cb56dc8e3504958b2a.tar.gz
vcpkg-ccca198c1b1730b0241911cb56dc8e3504958b2a.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..10d921d5c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Vcpkg
+
+## Overview
+Vcpkg helps you get C and C++ libraries on Windows. This tool and ecosystem are currently in a preview state; your involvement is vital to its success.
+
+For short description of available commands, run `vcpkg help`.
+
+## Quick Start
+If there is no `vcpkg.exe` (such as after a `git clone`), run
+```
+C:\src\vcpkg> powershell -exec bypass scripts\bootstrap.ps1
+```
+Then, to hook up user-wide integration, run (note: requires admin on first use)
+```
+C:\src\vcpkg> .\vcpkg integrate install
+```
+Finally, install any packages with
+```
+C:\src\vcpkg> .\vcpkg install sdl2 curl
+```
+
+## 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).
+
+## Contributing
+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.
+
+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.
+
+## License
+
+Code licensed under the [MIT License](LICENSE.txt).