X-Git-Url: https://git.ayoreis.com/hackapet/Adafruit_Blinka.git/blobdiff_plain/a8bd0c058b91b06b5e216632261503745a2cb675..c8d79678f137a451e1d6f8f024aa0fa1eb7dd10b:/README.rst diff --git a/README.rst b/README.rst index d33adb4..24db28b 100755 --- a/README.rst +++ b/README.rst @@ -13,11 +13,16 @@ Introduction :target: https://travis-ci.com/adafruit/Adafruit_Blinka :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + This repository contains a selection of packages mirroring the CircuitPython API on hosts running micropython. Working code exists to emulate the CircuitPython packages; * **board** - breakout-specific pin identities * **microcontroller** - chip-specific pin identities +* **analogio** - analog input/output pins, using pin identities from board+microcontroller packages * **digitalio** - digital input/output pins, using pin identities from board+microcontroller packages * **bitbangio** - software-driven interfaces for I2C, SPI * **busio** - hardware-driven interfaces for I2C, SPI, UART @@ -34,6 +39,31 @@ CircuitPython image, they have no value on a device already running CircuitPytho The test suites in the test/src folder under **testing.universal** are by design intended to run on *either* CircuitPython *or* Micropython+compatibility layer to prove conformance. +Installing from PyPI +===================== + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install Adafruit-Blinka + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install Adafruit-Blinka + +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-Blinka + Usage Example ============= @@ -47,7 +77,6 @@ the following sequence runs through some basic testing of the digitalio compatib An example log from running the suites is `here `_ . - Contributing ============