Skip to content

Commit ef5ddbd

Browse files
authored
Added PyPi installation instructions
1 parent 3013baa commit ef5ddbd

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.rst

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

40+
Installing from PyPI
41+
====================
42+
43+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
44+
PyPI <https://pypi.org/project/adafruit-circuitpython-rfm69/>`_. To install for current user:
45+
46+
.. code-block:: shell
47+
48+
pip3 install adafruit-circuitpython-rfm69
49+
50+
To install system-wide (this may be required in some cases):
51+
52+
.. code-block:: shell
53+
54+
sudo pip3 install adafruit-circuitpython-rfm69
55+
56+
To install in a virtual environment in your current project:
57+
58+
.. code-block:: shell
59+
60+
mkdir project-name && cd project-name
61+
python3 -m venv .env
62+
source .env/bin/activate
63+
pip3 install adafruit-circuitpython-rfm69
64+
65+
4066
Usage Example
4167
=============
4268
See examples/rfm69_simpletest.py for a simple demo of the usage.

0 commit comments

Comments
 (0)