Merge pull request #4 from jepler/add-readme

Create README.md

.github/workflows/pre-commit.yml

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: Copyright (c) 2019 Anthony Sottile
+#
+# SPDX-License-Identifier: MIT
+
+name: pre-commit
+
+on:
+  push:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-24.04
+    steps:
+    - name: Set up repository
+      uses: actions/checkout@v4
+      with:
+        submodules: false
+        show-progress: false
+        fetch-depth: 1
+        persist-credentials: false
+    - name: Set up python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.x
+    - name: Run pre-commit
+      uses: pre-commit/[email protected]
+    - name: Make patch
+      if: failure()
+      run: git diff > ~/pre-commit.patch
+    - name: Upload patch
+      if: failure()
+      uses: actions/upload-artifact@v4
+      with:
+        name: patch
+        path: ~/pre-commit.patch

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ ci:
 repos:
 # Standard hooks
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v5.0.0
   hooks:
   - id: check-added-large-files
   - id: check-case-conflict
@@ -35,21 +35,21 @@ repos:
 
 # Black, the code formatter, natively supports pre-commit
 - repo: https://github.com/psf/black
-  rev: 23.3.0
+  rev: 24.10.0
   hooks:
   - id: black
     files: ^(docs)
 
 # Lints code
 - repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: "v0.0.275"
+  rev: "v0.9.1"
   hooks:
   - id: ruff
     args: ["--fix", "--show-fixes"]
 
 # Changes tabs to spaces
 - repo: https://github.com/Lucas-C/pre-commit-hooks
-  rev: v1.5.1
+  rev: v1.5.5
   hooks:
   - id: remove-tabs
 

README.md

@@ -0,0 +1,55 @@
+Adafruit-Blinka-Raspberry-Pi5-Piomatter
+======================================
+
+|      CI              | status |
+|----------------------|--------|
+| pip builds           | [![Pip Actions Status][actions-pip-badge]][actions-pip-link] |
+| [`cibuildwheel`][]   | [![Wheels Actions Status][actions-wheels-badge]][actions-wheels-link] |
+
+[actions-badge]:           https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/workflows/Tests/badge.svg
+[actions-pip-link]:        https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/actions?query=workflow%3A%22Pip
+[actions-pip-badge]:       https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/workflows/Pip/badge.svg
+[actions-wheels-link]:     https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/actions?query=workflow%3AWheels
+[actions-wheels-badge]:    https://github.com/adafruit/Adafruit_Blinka_Raspberry_Pi5_Piomatter/workflows/Wheels/badge.svg
+
+Installation
+------------
+
+Installing from source:
+
+ - clone this repository
+ - `pip install ./Adafruit_Blinka_Raspberry_Pi5_Piomatter`
+
+Installing from pip:
+
+ - `pip install Adafruit-Blinka-Raspberry-Pi5-Piomatter`
+
+System setup
+------------
+
+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:
+
+```
+SUBSYSTEM=="*-pio", GROUP="gpio", MODE="0660"
+```
+
+Building the documentation
+--------------------------
+
+Documentation for the example project is generated using Sphinx. Sphinx has the
+ability to automatically inspect the signatures and documentation strings in
+the extension module to generate beautiful documentation in a variety formats.
+The following command generates HTML-based reference documentation; for other
+formats please refer to the Sphinx manual:
+
+ - `cd Adafruit_Blinka_Raspberry_Pi5_Piomatter/docs`
+ - `make html`
+
+License
+-------
+
+Adafruit\_Blinka\_Raspberry\_Pi5\_Piomatter is provided under the GPL-2-only license that can be found in the LICENSE
+file. By using, distributing, or contributing to this project, you agree to the
+terms and conditions of this license.
+
+[`cibuildwheel`]:          https://cibuildwheel.readthedocs.io