From: Melissa LeBlanc-Williams <melissa@adafruit.com>
Date: Wed, 15 Jul 2020 20:19:42 +0000 (-0700)
Subject: Added installation instructions to Readme
X-Git-Tag: 5.2.3^2~1
X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/ad309deabe36f91dd1588370cbf0db40f2b07e5c

Added installation instructions to Readme
---

diff --git a/README.rst b/README.rst
index 5e806ad..db48393 100755
--- a/README.rst
+++ b/README.rst
@@ -39,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-displayio/>`_. 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
 =============
 
@@ -52,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
 ============