Skip to content

Commit 777c15a

Browse files
authored
Merge pull request #13 from kattni/fix-up
Add version info, update README
2 parents 53bf421 + c3dd04c commit 777c15a

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

README.rst

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,32 @@ This driver depends on:
2525

2626
Please ensure all dependencies are available on the CircuitPython filesystem.
2727
This is easily achieved by downloading
28-
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
28+
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
29+
30+
Installing from PyPI
31+
=====================
32+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
33+
PyPI <https://pypi.org/project/adafruit-circuitpython-max31865/>`_. To install for current user:
34+
35+
.. code-block:: shell
36+
37+
pip3 install adafruit-circuitpython-max31865
38+
39+
To install system-wide (this may be required in some cases):
40+
41+
.. code-block:: shell
42+
43+
sudo pip3 install adafruit-circuitpython-max31865
44+
45+
To install in a virtual environment in your current project:
46+
47+
.. code-block:: shell
48+
49+
mkdir project-name && cd project-name
50+
python3 -m venv .env
51+
source .env/bin/activate
52+
pip3 install adafruit-circuitpython-max31865
53+
2954
3055
Usage Example
3156
=============
@@ -84,4 +109,4 @@ Now, once you have the virtual environment activated:
84109
85110
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
86111
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
87-
locally verify it will pass.
112+
locally verify it will pass.

adafruit_max31865.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@
5555

5656
import adafruit_bus_device.spi_device as spi_device
5757

58+
__version__ = "0.0.0-auto.0"
59+
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX31865.git"
5860

5961
#pylint: disable=bad-whitespace
6062
# Register and other constant values:

0 commit comments

Comments
 (0)