Skip to content

Commit 7d701cc

Browse files
author
Brennen Bearnes
committed
add pypi instructions to README
1 parent 2f76012 commit 7d701cc

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.rst

+27-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Introduction
32
============
43

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

20-
Dependencies
21-
=============
19+
Installation & Dependencies
20+
===========================
21+
2222
This driver depends on:
2323

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

2727
Please ensure all dependencies are available on the CircuitPython filesystem.
28-
This is easily achieved by downloading
29-
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
28+
This can be most easily achieved by downloading and installing
29+
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ on
30+
your device.
31+
32+
Installing from PyPI
33+
--------------------
34+
35+
On the Raspberry Pi, you can install the driver locally
36+
`from PyPI <https://pypi.org/project/adafruit-circuitpython-ads1x15/>`_. To
37+
install system-wide, use:
38+
39+
.. code-block:: shell
40+
41+
sudo pip3 install adafruit-circuitpython-ads1x15
42+
43+
To install in a virtual environment in your current project:
44+
45+
.. code-block:: shell
46+
47+
mkdir project-name && cd project-name
48+
python3 -m venv .env
49+
source .env/bin/activate
50+
pip3 install adafruit-circuitpython-ads1x15
3051
3152
Usage Example
3253
=============
@@ -94,7 +115,7 @@ Then run the build:
94115
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ads1x15 --library_location .
95116
96117
Sphinx documentation
97-
-----------------------
118+
--------------------
98119

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

0 commit comments

Comments
 (0)