Skip to content

Commit c2462e7

Browse files
authored
Added PyPi installation instructions
1 parent db8dfb4 commit c2462e7

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
@@ -52,6 +52,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
5252
This is easily achieved by downloading
5353
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
5454

55+
Installing from PyPI
56+
====================
57+
58+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
59+
PyPI <https://pypi.org/project/adafruit-circuitpython-ds3231/>`_. To install for current user:
60+
61+
.. code-block:: shell
62+
63+
pip3 install adafruit-circuitpython-ds3231
64+
65+
To install system-wide (this may be required in some cases):
66+
67+
.. code-block:: shell
68+
69+
sudo pip3 install adafruit-circuitpython-ds3231
70+
71+
To install in a virtual environment in your current project:
72+
73+
.. code-block:: shell
74+
75+
mkdir project-name && cd project-name
76+
python3 -m venv .env
77+
source .env/bin/activate
78+
pip3 install adafruit-circuitpython-ds3231
79+
5580
Usage Notes
5681
===========
5782

0 commit comments

Comments
 (0)