diff --git a/README.rst b/README.rst index e4628df..0841e3d 100644 --- a/README.rst +++ b/README.rst @@ -27,38 +27,44 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. -Usage Example -============= +Installing from PyPI +==================== -See examples/drv2605_simpletest.py for a demo of the usage. +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: -Contributing -============ +.. code-block:: shell -Contributions are welcome! Please read our `Code of Conduct -`_ -before contributing to help this project stay welcoming. + pip3 install adafruit-circuitpython-drv2605 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell -Building locally -================ + sudo pip3 install adafruit-circuitpython-drv2605 -To build this library locally you'll need to install the -`circuitpython-build-tools `_ package. +To install in a virtual environment in your current project: .. code-block:: shell + mkdir project-name && cd project-name python3 -m venv .env source .env/bin/activate - pip install circuitpython-build-tools + pip3 install adafruit-circuitpython-drv2605 -Once installed, make sure you are in the virtual environment: +Usage Example +============= -.. code-block:: shell +See examples/drv2605_simpletest.py for a demo of the usage. - source .env/bin/activate +Contributing +============ -Then run the build: +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. -.. code-block:: shell +Documentation +============= - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-drv2605 --library_location . +For information on building library documentation, please check out `this guide `_.