aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Schodet2022-01-22 22:37:34 +0100
committerNicolas Schodet2022-01-22 22:37:34 +0100
commitbc268f0da6aad0feba8c5643ef5a431ccbf3b4dc (patch)
treed20e0d9da5337a938b2453b601d686943924e318
parent956a2164aee0bc47b61e8aaf2605d7c83ac25ffd (diff)
Add a note about libusb which needs to be installed for PyUSB
Closes https://github.com/schodet/nxt-python/issues/178
-rw-r--r--docs/installation.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index 9926b2c..16df133 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -26,6 +26,17 @@ USB support is provided by PyUSB which is installed automatically with
NXT-Python. You can also use the package from your Linux distribution if you
wish, in this case, install it before installing NXT-Python.
+PyUSB requires libusb or OpenUSB running on your system.
+
+- For Linux users, you can install it from your package manager if not
+ installed yet.
+- For MacOS users, you can use ``brew install libusb`` to install it using
+ Homebrew.
+- For Windows users, libusb 1.0 DLLs are provided in the releases. Check the
+ `libusb website`_.
+
+.. _libusb website: http://www.libusb.info
+
Bluetooth
---------