diff options
| author | Robin Krahl <robin.krahl@ireas.org> | 2019-01-13 13:51:23 +0100 |
|---|---|---|
| committer | Daniel Mueller <deso@posteo.net> | 2019-01-13 19:52:21 -0800 |
| commit | 31ddac85fd6858ad785bb566f7e076e883dab3ec (patch) | |
| tree | 524b5bab947607bc3057fae3f962c0f0ad47f524 | |
| parent | 1f04f0f9fde82f0d931ca0714e4ac6cab7824b1c (diff) | |
| download | nitrocli-31ddac85fd6858ad785bb566f7e076e883dab3ec.tar.gz nitrocli-31ddac85fd6858ad785bb566f7e076e883dab3ec.tar.bz2 | |
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.
| -rw-r--r-- | nitrocli/README.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/nitrocli/README.md b/nitrocli/README.md index 7102bdf..1f7a8c1 100644 --- a/nitrocli/README.md +++ b/nitrocli/README.md @@ -106,6 +106,12 @@ $ 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 +139,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 |