Merge pull request #10 from adafruit/pypi-readme
update readme with PyPI install instructions
This commit is contained in:
commit
8d40ab80c7
1 changed files with 25 additions and 0 deletions
25
README.rst
25
README.rst
|
@ -26,6 +26,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
|
||||||
This is easily achieved by downloading
|
This is easily achieved by downloading
|
||||||
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
|
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
|
||||||
|
|
||||||
|
Installing from PyPI
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
|
||||||
|
PyPI <https://pypi.org/project/adafruit-circuitpython-pn532/>`_. To install for current user:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
pip3 install adafruit-circuitpython-pn532
|
||||||
|
|
||||||
|
To install system-wide (this may be required in some cases):
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
sudo pip3 install adafruit-circuitpython-pn532
|
||||||
|
|
||||||
|
To install in a virtual environment in your current project:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
mkdir project-name && cd project-name
|
||||||
|
python3 -m venv .env
|
||||||
|
source .env/bin/activate
|
||||||
|
pip3 install adafruit-circuitpython-pn532
|
||||||
|
|
||||||
Usage Example
|
Usage Example
|
||||||
=============
|
=============
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue