summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--nitrocli/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md
index 7102bdf..51db5c0 100644
--- a/nitrocli/README.md
+++ b/nitrocli/README.md
@@ -106,6 +106,13 @@ $ cargo build --release
It is recommended that the resulting executable be installed in a
directory accessible via the `PATH` environment variable.
+#### Known Problems
+
+Due to a problem with the default `hidapi` version on macOS, users are advised
+to build and install [`libnitrokey`][] from source and then set the
+`USE_SYSTEM_LIBNITROKEY` environment variable when building `nitrocli` using
+one of the methods described above.
+
Contributing
------------
@@ -133,6 +140,7 @@ See the [LICENSE](LICENSE) file that accompanies this distribution for
the full text of the license.
+[`libnitrokey`]: https://github.com/nitrokey/libnitrokey
[nitrokey-ug]: https://www.nitrokey.com
[nitrokey-pro]: https://shop.nitrokey.com/shop/product/nitrokey-pro-2-3
[nitrokey-storage]: https://shop.nitrokey.com/shop/product/nitrokey-storage-2-16gb-23