Merge pull request #376 from mcauser/patch-1

[Adafruit_Blinka-hackapet.git] / README.rst

diff --git a/README.rst b/README.rst
index d33adb4e693abdfa0cc9e30d0c4af4974ce609c5..2f2b7134db874f91b586fba837ea2a6311f1188f 100755 (executable)
--- a/README.rst
+++ b/README.rst
@@ -6,18 +6,23 @@ Introduction
     :alt: Documentation Status
 
 .. image:: https://img.shields.io/discord/327254708534116352.svg
-    :target: https://discord.gg/nBQh6qu
+    :target: https://adafru.it/discord
     :alt: Discord
 
 .. image:: https://travis-ci.com/adafruit/Adafruit_Blinka.svg?branch=master
     :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 <https://pypi.org/project/Adafruit-Blinka/>`_. 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 <https://github.com/cefn/Adafruit_Micropython_Blinka/issues/2#issuecomment-366713394>`_ .
 
-
 Contributing
 ============