1  Adafruit-Blinka-rp1pio
 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_rp1pio/workflows/Tests/badge.svg
10  [actions-pip-link]:        https://github.com/adafruit/Adafruit_Blinka_rp1pio/actions?query=workflow%3A%22Pip
11  [actions-pip-badge]:       https://github.com/adafruit/Adafruit_Blinka_rp1pio/workflows/Pip/badge.svg
12  [actions-wheels-link]:     https://github.com/adafruit/Adafruit_Blinka_rp1pio/actions?query=workflow%3AWheels
13  [actions-wheels-badge]:    https://github.com/adafruit/Adafruit_Blinka_rp1pio/workflows/Wheels/badge.svg
14  
15  Installation
16  ------------
17  
18  Installing from source:
19  
20   - clone this repository
21   - `pip install ./Adafruit_Blinka_rp1pio`
22  
23  Installing from pip (not yet available):
24  
25   - `pip install Adafruit_Blinka_rp1pio`
26  
27  Building the documentation
28  --------------------------
29  
30  Documentation for the example project is generated using Sphinx. Sphinx has the
31  ability to automatically inspect the signatures and documentation strings in
32  the extension module to generate beautiful documentation in a variety formats.
33  The following command generates HTML-based reference documentation; for other
34  formats please refer to the Sphinx manual:
35  
36   - `cd Adafruit_Blinka_rp1pio`
37   - `pip install '.[docs]'`
38   - `make -C docs html`
39  
40  License
41  -------
42  
43  Adafruit\_Blinka\_rp1pio is provided under the GPL-2-only license that can be found in the LICENSE
44  file. By using, distributing, or contributing to this project, you agree to the
45  terms and conditions of this license.
46  
47  [`cibuildwheel`]:          https://cibuildwheel.readthedocs.io