From 321dd4b4986aa7e5eba8057b4ce887dced5d24c7 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Sun, 13 Jan 2019 13:51:23 +0100 Subject: Document known problems on macOS This change adds a new section briefly elaborating on the problem of using the program on macOS and details a possible solution. --- nitrocli/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) 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 -- cgit v1.2.3