Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alexkaratarakis committed Jun 8, 2018
1 parent 91ec5c4 commit 39c7057
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Vcpkg <a href="#">![](https://devdiv.visualstudio.com/_apis/public/build/definitions/0bdbc590-a062-4c3f-b0f6-9383f67865ee/8476/badge)</a>

## Overview
Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are currently in a preview state; your involvement is vital to its success!
Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are constantly evolving; your involvement are vital to its success!

For short description of available commands, run `vcpkg help`.

Expand Down Expand Up @@ -37,7 +37,7 @@ The best way to use installed libraries with CMake is via the toolchain file `sc

In Visual Studio, you can create a New Project (or open an existing one). All installed libraries are immediately ready to be `#include`'d and used in your project without additional configuration.

For more information, see our [using a package](docs/examples/using-sqlite.md) example for the specifics.
For more information, see our [using a package](docs/examples/using-sqlite.md) example for the specifics.

Additional notes on macOS and Linux support can be found in the [official announcement](https://blogs.msdn.microsoft.com/vcblog/2018/04/24/announcing-a-single-c-library-manager-for-linux-macos-and-windows-vcpkg/).

Expand Down
2 changes: 1 addition & 1 deletion docs/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ See the [Privacy document](privacy.md) for all information regarding privacy.
Yes. If you already have a CMake toolchain file, you will need to include our toolchain file at the end of yours. This should be as simple as an `include(<vcpkg_root>\scripts\buildsystems\vcpkg.cmake)` directive. Alternatively, you could copy the contents of our `scripts\buildsystems\vcpkg.cmake` into the end of your existing toolchain file.

## Can I use my own/specific flags for rebuilding libs?
Yes. In the current preview, there is not yet a standardized global way to change them, however you can edit individual portfiles and tweak the exact build process however you'd like.
Yes. In the current version, there is not yet a standardized global way to change them, however you can edit individual portfiles and tweak the exact build process however you'd like.

By saving the changes to the portfile (and checking them in), you'll get the same results even if you're rebuilding from scratch in the future and forgot what exact settings you used.

Expand Down
7 changes: 6 additions & 1 deletion docs/about/privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ We do collect telemetry data from usage of "vcpkg.exe". We explicitly ONLY colle

## What telemetry is collected?

We collect the command line used, the time of invocation, and how long the command took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event. For this preview, we do not offer a mechanism to disable this data collection since it is critical for improving the product. In the full release, you will be able to opt-out with a simple configuration. For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-us/privacy.
We collect the command line used, the time of invocation, and how long execution took. Some commands also add additional calculated information (such as the full set of libraries to install). We generate a completely random UUID on first use and attach it to each event.
In order to opt-out of data collection, you can re-run the boostrap script with the following flag:

```PS> .\bootstrap-vcpkg.bat -disableMetrics 1```

For more information about how Microsoft protects your privacy, see https://privacy.microsoft.com/en-us/privacy.

Here is an example of an event for the command line `vcpkg install zlib`:
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Quick Start

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.
Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are constantly evolving; your involvement are vital to its success!

- [How to use Sqlite in your application](examples/using-sqlite.md)

Expand Down

0 comments on commit 39c7057

Please sign in to comment.