Skip to content

Commit 4d000c5

Browse files
authored
Merge pull request #12 from adafruit/pypi-readme-update
PyPI readme update
2 parents 4d55aac + 4c7d12b commit 4d000c5

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.rst

+27-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Introduction
1616

1717
A CircuitPython driver for the Sensirion SGP30 gas sensor with eCO2 and TVOC output. This sensor uses I2C!
1818

19-
Dependencies
20-
=============
19+
Installation and Dependencies
20+
=============================
2121
This driver depends on:
2222

2323
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
@@ -27,6 +27,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2727
This is easily achieved by downloading
2828
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2929

30+
Installing from PyPI
31+
--------------------
32+
33+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
34+
PyPI <https://pypi.org/project/adafruit-circuitpython-sgp30/>`_. To install for current user:
35+
36+
.. code-block:: shell
37+
38+
pip3 install adafruit-circuitpython-sgp30
39+
40+
To install system-wide (this may be required in some cases):
41+
42+
.. code-block:: shell
43+
44+
sudo pip3 install adafruit-circuitpython-sgp30
45+
46+
To install in a virtual environment in your current project:
47+
48+
.. code-block:: shell
49+
50+
mkdir project-name && cd project-name
51+
python3 -m venv .env
52+
source .env/bin/activate
53+
pip3 install adafruit-circuitpython-sgp30
54+
3055
Usage Notes
3156
=============
3257

0 commit comments

Comments
 (0)