diff options
Diffstat (limited to 'vendor/vcpkg/README.md')
| -rw-r--r-- | vendor/vcpkg/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/vendor/vcpkg/README.md b/vendor/vcpkg/README.md new file mode 100644 index 000000000..d84055ef0 --- /dev/null +++ b/vendor/vcpkg/README.md @@ -0,0 +1,23 @@ +# vcpkg-rs [](https://github.com/mcgoo/vcpkg-rs/actions?query=workflow%3AWindows) [](https://github.com/mcgoo/vcpkg-rs/actions?query=workflow%3AmacOS) [](https://github.com/mcgoo/vcpkg-rs/actions?query=workflow%3ALinux)
+
+[Documentation](https://docs.rs/vcpkg) [Changelog](CHANGELOG.md)
+
+This is a helper for finding libraries in a [Vcpkg](https://github.com/Microsoft/vcpkg) installation from cargo build scripts. It works similarly to [pkg-config](https://github.com/alexcrichton/pkg-config-rs). It works on Windows (MSVC ABI), Linux and MacOS.
+
+## Example
+
+Find the library named `foo` in a [Vcpkg](https://github.com/Microsoft/vcpkg) installation and emit cargo metadata to link it:
+
+```rust
+// build.rs
+fn main() {
+ vcpkg::find_package("foo").unwrap();
+}
+```
+
+See the crate [documentation](https://docs.rs/vcpkg) for more information. See [cargo-vcpkg](https://crates.io/crates/cargo-vcpkg) for a convenient way of creating a vcpkg installation.
+
+## License
+
+See LICENSE-APACHE, and LICENSE-MIT for details.
+
|