Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs to set VCPKG_ROOT to run tests #45

Merged
merged 1 commit into from
Apr 6, 2021
Merged

Add docs to set VCPKG_ROOT to run tests #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ writing new tests and keeping them up to date is also very important. If one's
code is subtly broken, we'd rather find it out right away than a few weeks down
the line when someone complains!

## Environment Variables

You will need to set the environment variable `VCPKG_ROOT` to the location
of a copy of the [main vcpkg repo](https://github.com/microsoft/vcpkg) on your
machine, in order to run the tests.

Failure to do so will result in this error, when some of the tests are run:

```
Error: Could not detect vcpkg-root.
```

## Running Tests

Before anything else, we should know whether you can actually run the tests!
Expand Down