aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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