Skip to content

Commit 39f4ad4

Browse files
authored
Added PyPi installation instructions
1 parent 52349ef commit 39f4ad4

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.rst

+25
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
3030
This is easily achieved by downloading
3131
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3232

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

0 commit comments

Comments
 (0)