From 54a65248411c5f77fc4c1d1ed15d18b574b75ca5 Mon Sep 17 00:00:00 2001 From: Kattni Date: Thu, 20 Dec 2018 14:08:27 -0600 Subject: [PATCH] update readme with PyPI install instructions --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index 528e78b..9667a5b 100644 --- a/README.rst +++ b/README.rst @@ -26,6 +26,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `the Adafruit library and driver bundle `_. +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-pn532 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-pn532 + +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-pn532 + Usage Example =============