@@ -27,38 +27,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
27
27
This is easily achieved by downloading
28
28
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle >`_.
29
29
30
- Usage Example
31
- =============
30
+ Installing from PyPI
31
+ ====================
32
32
33
- See examples/drv2605_simpletest.py for a demo of the usage.
33
+ On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
34
+ PyPI <https://pypi.org/project/adafruit-circuitpython-drv2605/> `_. To install for current user:
34
35
35
- Contributing
36
- ============
36
+ .. code-block :: shell
37
37
38
- Contributions are welcome! Please read our `Code of Conduct
39
- <https://github.com/adafruit/Adafruit_CircuitPython_DRV2605/blob/master/CODE_OF_CONDUCT.md> `_
40
- before contributing to help this project stay welcoming.
38
+ pip3 install adafruit-circuitpython-drv2605
39
+
40
+ To install system-wide (this may be required in some cases):
41
+
42
+ .. code-block :: shell
41
43
42
- Building locally
43
- ================
44
+ sudo pip3 install adafruit-circuitpython-drv2605
44
45
45
- To build this library locally you'll need to install the
46
- `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools >`_ package.
46
+ To install in a virtual environment in your current project:
47
47
48
48
.. code-block :: shell
49
49
50
+ mkdir project-name && cd project-name
50
51
python3 -m venv .env
51
52
source .env/bin/activate
52
- pip install circuitpython-build-tools
53
+ pip3 install adafruit- circuitpython-drv2605
53
54
54
- Once installed, make sure you are in the virtual environment:
55
+ Usage Example
56
+ =============
55
57
56
- .. code-block :: shell
58
+ See examples/drv2605_simpletest.py for a demo of the usage.
57
59
58
- source .env/bin/activate
60
+ Contributing
61
+ ============
59
62
60
- Then run the build:
63
+ Contributions are welcome! Please read our `Code of Conduct
64
+ <https://github.com/adafruit/Adafruit_CircuitPython_DRV2605/blob/master/CODE_OF_CONDUCT.md> `_
65
+ before contributing to help this project stay welcoming.
61
66
62
- .. code-block :: shell
67
+ Documentation
68
+ =============
63
69
64
- circuitpython-build-bundles --filename_prefix adafruit- circuitpython-drv2605 --library_location .
70
+ For information on building library documentation, please check out ` this guide < https://learn. adafruit.com/creating-and-sharing-a- circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1 >`_ .
0 commit comments