From 4c7d12bc0bd936dd77e4b6de483746532d5c5ba6 Mon Sep 17 00:00:00 2001 From: Kattni Date: Wed, 31 Oct 2018 17:12:28 -0400 Subject: [PATCH] PyPI readme update --- README.rst | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index fa74cfb..b518c38 100644 --- a/README.rst +++ b/README.rst @@ -16,8 +16,8 @@ Introduction A CircuitPython driver for the Sensirion SGP30 gas sensor with eCO2 and TVOC output. This sensor uses I2C! -Dependencies -============= +Installation and Dependencies +============================= This driver depends on: * `Adafruit CircuitPython `_ @@ -27,6 +27,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-sgp30 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-sgp30 + +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-sgp30 + Usage Notes =============