Skip to content

Commit a6573fd

Browse files
authored
Added PyPi installation instructions
1 parent 5bf013d commit a6573fd

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
3232
This is easily achieved by downloading
3333
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3434

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

0 commit comments

Comments
 (0)