From f31bdf2db9bd92baf63f6b3b0f76e241189f37a3 Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Tue, 14 Jan 2020 09:13:28 -0500 Subject: [PATCH 1/2] Added installing from pypi section --- README.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.rst b/README.rst index 0a3dba2..7ddb129 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-ble + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-ble + +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-ble + Usage Example ============= From 506067509a8b674030f056d4ed08526e8a4c504d Mon Sep 17 00:00:00 2001 From: dherrada <33632497+dherrada@users.noreply.github.com> Date: Thu, 16 Jan 2020 14:30:36 -0500 Subject: [PATCH 2/2] Made requested changes --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index 7ddb129..f44996d 100644 --- a/README.rst +++ b/README.rst @@ -29,6 +29,8 @@ This is easily achieved by downloading Installing from PyPI ==================== +Warning: This will _not_ work with BLE on Linux + On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI `_. To install for current user: