1  Adafruit-Blinka-Raspberry-Pi5-Piomatter
 2  ======================================
 3  
 4  |      CI              | status |
 5  |----------------------|--------|
 6  | pip builds           | [![Pip Actions Status][actions-pip-badge]][actions-pip-link] |
 7  | [`cibuildwheel`][]   | [![Wheels Actions Status][actions-wheels-badge]][actions-wheels-link] |
 8  
 9  [actions-badge]:           https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/workflows/Tests/badge.svg
10  [actions-pip-link]:        https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/actions?query=workflow%3A%22Pip
11  [actions-pip-badge]:       https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/workflows/Pip/badge.svg
12  [actions-wheels-link]:     https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/actions?query=workflow%3AWheels
13  [actions-wheels-badge]:    https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/workflows/Wheels/badge.svg
14  
15  Installation
16  ------------
17  
18  Installing from source:
19  
20   - clone this repository
21   - `pip install ./Adafruit_Blinka_Raspberry_Pi5_Piomatter`
22  
23  Installing from pip:
24  
25   - `pip install Adafruit-Blinka-Raspberry-Pi5-Piomatter`
26  
27  System setup
28  ------------
29  
30  If `ls -l /dev/pio0` reports that the file is not found, you may need to update your Pi 5 firmware to one with PIO support and make sure that you are running a suitably recent kernel. If `ls -l /dev/pio0` reports that the file is owned by root and group root, you should add the following to /etc/udev/rules/99-com.rules:
31  
32  ```
33  SUBSYSTEM=="*-pio", GROUP="gpio", MODE="0660"
34  ```
35  
36  Building the documentation
37  --------------------------
38  
39  Documentation for the example project is generated using Sphinx. Sphinx has the
40  ability to automatically inspect the signatures and documentation strings in
41  the extension module to generate beautiful documentation in a variety formats.
42  The following command generates HTML-based reference documentation; for other
43  formats please refer to the Sphinx manual:
44  
45   - `cd Adafruit_Blinka_Raspberry_Pi5_Piomatter/docs`
46   - `make html`
47  
48  License
49  -------
50  
51  Adafruit\_Blinka\_Raspberry\_Pi5\_Piomatter is provided under the GPL-2-only license that can be found in the LICENSE
52  file. By using, distributing, or contributing to this project, you agree to the
53  terms and conditions of this license.
54  
55  [`cibuildwheel`]:          https://cibuildwheel.readthedocs.io