Skip to content

Commit 329b12d

Browse files
authored
Merge pull request #17 from adafruit/dherrada-patch-1
Removed building locally section from README, replaced with documentation section
2 parents 765c81c + d18eb06 commit 329b12d

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

README.rst

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2727
This is easily achieved by downloading
2828
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2929

30-
Usage Example
31-
=============
30+
Installing from PyPI
31+
====================
3232

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:
3435

35-
Contributing
36-
============
36+
.. code-block:: shell
3737
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
4143
42-
Building locally
43-
================
44+
sudo pip3 install adafruit-circuitpython-drv2605
4445
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:
4747

4848
.. code-block:: shell
4949
50+
mkdir project-name && cd project-name
5051
python3 -m venv .env
5152
source .env/bin/activate
52-
pip install circuitpython-build-tools
53+
pip3 install adafruit-circuitpython-drv2605
5354
54-
Once installed, make sure you are in the virtual environment:
55+
Usage Example
56+
=============
5557

56-
.. code-block:: shell
58+
See examples/drv2605_simpletest.py for a demo of the usage.
5759

58-
source .env/bin/activate
60+
Contributing
61+
============
5962

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.
6166

62-
.. code-block:: shell
67+
Documentation
68+
=============
6369

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

Comments
 (0)