Skip to content

Commit 9a07833

Browse files
authored
Added pypi installation instructions
1 parent ccc511a commit 9a07833

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,26 @@ 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-rtttl/>`_. To install for current user:
35+
36+
.. code-block:: shell
37+
pip3 install adafruit-circuitpython-rtttl
38+
To install system-wide (this may be required in some cases):
39+
40+
.. code-block:: shell
41+
sudo pip3 install adafruit-circuitpython-rtttl
42+
To install in a virtual environment in your current project:
43+
44+
.. code-block:: shell
45+
mkdir project-name && cd project-name
46+
python3 -m venv .env
47+
source .env/bin/activate
48+
pip3 install adafruit-circuitpython-rtttl
49+
3050
Usage Example
3151
=============
3252

0 commit comments

Comments
 (0)