Merge pull request #13 from kattni/fix-up

Add version info, update README
This commit is contained in:
Limor "Ladyada" Fried 2019-09-19 18:32:09 -04:00 committed by GitHub
commit 777c15a175
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 2 deletions

View File

@ -25,7 +25,32 @@ This driver depends on:
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>`_.
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-max31865/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-max31865
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-max31865
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-max31865
Usage Example
=============

View File

@ -55,6 +55,8 @@ from micropython import const
import adafruit_bus_device.spi_device as spi_device
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX31865.git"
#pylint: disable=bad-whitespace
# Register and other constant values: