aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2020-09-22 19:09:40 +0200
committerRobin Krahl <robin.krahl@ireas.org>2020-09-22 19:09:40 +0200
commitc484777f3a7dde9e9fe8f47344fd8a6b30840b78 (patch)
tree3d6c111f619e8b2b428e9a1744a9dc15b4f1ca3d /README.md
parent4932d2376cc03c64eb82972824be673cdc2e0741 (diff)
downloadnitrokey-sys-rs-c484777f3a7dde9e9fe8f47344fd8a6b30840b78.tar.gz
nitrokey-sys-rs-c484777f3a7dde9e9fe8f47344fd8a6b30840b78.tar.bz2
Add feature to generate bindings during build
This patch adds the bindgen feature to the crate that allows users to re-generate the bindings, including layout tests, during the build instead of using the pre-generated bindings. Per default, this feature is disabled.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 343b7b5..2646a33 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,13 @@ crate, it links directly against `libnitrokey` instead of building it from
source. In this case, `libnitrokey` must be available in the library search
path.
+Per default, this crate uses bindings that have been generated using Rust’s
+`x86_64-unknown-linux-gnu` target. To the best of our knowledge, these
+bindings are platform-independent. If you want to generate the bindings,
+including layout tests, specifically for your platform during the build,
+activate the `bindgen` feature. In this case, you will also need `clang` and
+`libclang` in the default search path.
+
## Versioning
The major and minor version of the `nitrokey-sys` crate map to the major and