Skip to content

add pypi instructions to README #14

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.

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 1 commit into from
Aug 6, 2018
Merged
Changes from all commits
Commits
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
33 changes: 27 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

Introduction
============

Expand All @@ -17,16 +16,38 @@ Introduction
Support for the ADS1x15 series of analog-to-digital converters. Available in 12-bit (ADS1015)
and 16-bit (ADS1115) versions.

Dependencies
=============
Installation & Dependencies
===========================

This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_

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>`_.
This can be most easily achieved by downloading and installing
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ on
your device.

Installing from PyPI
--------------------

On the Raspberry Pi, you can install the driver locally
`from PyPI <https://pypi.org/project/adafruit-circuitpython-ads1x15/>`_. To
install system-wide, use:

.. code-block:: shell

sudo pip3 install adafruit-circuitpython-ads1x15

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
pip3 install adafruit-circuitpython-ads1x15

Usage Example
=============
Expand Down Expand Up @@ -94,7 +115,7 @@ Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ads1x15 --library_location .

Sphinx documentation
-----------------------
--------------------

Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
Expand Down