91f88feaf5418417ee54af53b152c6edad757c73
[EVA-2020-02-2.git] / library / README.rst
1 Enviro+ pHAT
2 ============
3
4 |Build Status| |Coverage Status| |PyPi Package| |Python Versions|
5
6 Installing
7 ==========
8
9 Stable library from PyPi:
10
11 - Just run ``sudo pip install enviroplus``
12
13 (**Note** that you're best using the git clone / install.sh method below
14 if you want all of the UART serial configuration for the PMS5003
15 particulate matter sensor to run automatically)
16
17 Latest/development library from GitHub:
18
19 - ``git clone https://github.com/pimoroni/enviroplus-python``
20 - ``cd enviroplus-python``
21 - ``sudo ./install.sh``
22
23 .. |Build Status| image:: https://travis-ci.com/pimoroni/enviroplus-python.svg?branch=master
24 :target: https://travis-ci.com/pimoroni/enviroplus-python
25 .. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/enviroplus-python/badge.svg?branch=master
26 :target: https://coveralls.io/github/pimoroni/enviroplus-python?branch=master
27 .. |PyPi Package| image:: https://img.shields.io/pypi/v/enviroplus.svg
28 :target: https://pypi.python.org/pypi/enviroplus
29 .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/enviroplus.svg
30 :target: https://pypi.python.org/pypi/enviroplus