aboutsummaryrefslogtreecommitdiff
path: root/nitrokey-sys/README.md
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2019-01-12 13:09:49 -0800
committerDaniel Mueller <deso@posteo.net>2019-01-12 13:09:49 -0800
commit16ed68c0f5e3ccb330c7a5f7c11781bc7a129b03 (patch)
treef748675f5b510d548d7f9de7f3ed8b4b83219616 /nitrokey-sys/README.md
parent0083f9dc7104dd21883451ad18c70758469ce1de (diff)
downloadnitrocli-16ed68c0f5e3ccb330c7a5f7c11781bc7a129b03.tar.gz
nitrocli-16ed68c0f5e3ccb330c7a5f7c11781bc7a129b03.tar.bz2
Update nitrokey-sys crate to 3.4.3
This change updates the nitrokey-sys crate to version 3.4.3. Import subrepo nitrokey-sys/:nitrokey-sys at fe86df47853718983e1f45d6a4289a1d93ace45c
Diffstat (limited to 'nitrokey-sys/README.md')
-rw-r--r--nitrokey-sys/README.md24
1 files changed, 15 insertions, 9 deletions
diff --git a/nitrokey-sys/README.md b/nitrokey-sys/README.md
index 9b4f654..343b7b5 100644
--- a/nitrokey-sys/README.md
+++ b/nitrokey-sys/README.md
@@ -3,17 +3,23 @@
Low-level Rust bindings for `libnitrokey`, providing access to Nitrokey
devices.
-```toml
-[dependencies]
-nitrokey-sys = "3.4.1"
-```
+This crate contains a copy of the [`libnitrokey`][] library, builds it from
+source and links it statically. The host system must provide its dependencies
+in the library search path:
-The version of this crate corresponds to the wrapped `libnitrokey` version.
-This crate contains a copy of the `libnitrokey` library, builds it from source
-and links it statically. The host system must provide its dependencies in the
-library search path:
+- `libhidapi-libusb0` (on Linux)
+- `libhidapi` (on non-Linux systems)
-- `libhidapi-libusb0`
+If you set the `USE_SYSTEM_LIBNITROKEY` environment variable when building this
+crate, it links directly against `libnitrokey` instead of building it from
+source. In this case, `libnitrokey` must be available in the library search
+path.
+
+## Versioning
+
+The major and minor version of the `nitrokey-sys` crate map to the major and
+minor version of `libnitrokey`. The `nitrokey-sys` patch version may be
+increased independently.
## Contact