From 587e801d6adc99631e5ae00cb2ade34c577bcc13 Mon Sep 17 00:00:00 2001 From: Kattni Date: Thu, 29 Nov 2018 12:14:45 -0500 Subject: [PATCH] Added PyPI instructions to README --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index 409a8f4..b89e3f3 100644 --- a/README.rst +++ b/README.rst @@ -19,6 +19,31 @@ This library is compatible with standard Character LCDs such as: * `Adafruit RGB backlight negative LCD 16x2 `_ * `Adafruit RGB backlight negative LCD 20x4 `_ +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-circuitpython-charlcd + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-charlcd + +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-charlcd + Dependencies ============= This driver depends on: