summaryrefslogtreecommitdiff
path: root/pkg-config/README.md
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2017-03-26 17:07:11 -0700
committerDaniel Mueller <deso@posteo.net>2017-03-26 17:07:11 -0700
commit547085cdefb3372e8c42beabac5d45f2f6b1a535 (patch)
tree63521a302332627b72ce3df73abc96a742026fbb /pkg-config/README.md
parent701c71952afc199fc1a9f0d45a7b5fb08cabffe8 (diff)
downloadnitrocli-547085cdefb3372e8c42beabac5d45f2f6b1a535.tar.gz
nitrocli-547085cdefb3372e8c42beabac5d45f2f6b1a535.tar.bz2
Import subrepo pkg-config/:pkg-config at a493b0d7c93df68c94d1bad2a1f419389e52c0f5
Diffstat (limited to 'pkg-config/README.md')
-rw-r--r--pkg-config/README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/pkg-config/README.md b/pkg-config/README.md
new file mode 100644
index 0000000..80e372a
--- /dev/null
+++ b/pkg-config/README.md
@@ -0,0 +1,44 @@
+# pkg-config-rs
+
+[![Build Status](https://travis-ci.org/alexcrichton/pkg-config-rs.svg?branch=master)](https://travis-ci.org/alexcrichton/pkg-config-rs)
+
+[Documentation](http://alexcrichton.com/pkg-config-rs)
+
+A simple library meant to be used as a build dependency with Cargo packages in
+order to use the system `pkg-config` tool (if available) to determine where a
+library is located.
+
+You can use this crate directly to probe for specific libraries, or use
+[metadeps](https://github.com/joshtriplett/metadeps) to declare all your
+`pkg-config` dependencies in `Cargo.toml`.
+
+# Example
+
+Find the system library named `foo`, with minimum version 1.2.3:
+
+```rust
+extern crate pkg_config;
+
+fn main() {
+ pkg_config::Config::new().atleast_version("1.2.3").probe("foo").unwrap();
+}
+```
+
+Find the system library named `foo`, with no version requirement (not
+recommended):
+
+```rust
+extern crate pkg_config;
+
+fn main() {
+ pkg_config::probe_library("foo").unwrap();
+}
+```
+
+# License
+
+`pkg-config-rs` is primarily distributed under the terms of both the MIT
+license and the Apache License (Version 2.0), with portions covered by various
+BSD-like licenses.
+
+See LICENSE-APACHE, and LICENSE-MIT for details.