Skip to content

Removed building locally section from README, replaced with documentation section #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 21, 2019
Merged

Removed building locally section from README, replaced with documentation section #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ba2433
Update README.rst
evaherrada Oct 17, 2019
d18eb06
Added PyPi installation instructions
evaherrada Oct 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 25 additions & 19 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/adafruit/Adafruit_CircuitPython_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 <https://pypi.org/project/adafruit-circuitpython-drv2605/>`_. To install for current user:

Contributing
============
.. code-block:: shell

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_DRV2605/blob/master/CODE_OF_CONDUCT.md>`_
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 <https://github.com/adafruit/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
<https://github.com/adafruit/Adafruit_CircuitPython_DRV2605/blob/master/CODE_OF_CONDUCT.md>`_
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 <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.