From 5f76880987ae401bab8e6dca5b9bfd06f2c13609 Mon Sep 17 00:00:00 2001 From: Adrian Del Grosso <10929341+ad3154@users.noreply.github.com> Date: Sun, 10 Sep 2023 10:20:17 -0600 Subject: [PATCH] [CI]: Add library linting action --- .github/FUNDING.yml | 1 + .github/workflows/linting.yml | 7 +++++++ README.md | 4 +++- 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 .github/FUNDING.yml create mode 100644 .github/workflows/linting.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..8569fc0 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: ad3154 diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml new file mode 100644 index 0000000..1c18b7b --- /dev/null +++ b/.github/workflows/linting.yml @@ -0,0 +1,7 @@ +on: [push, pull_request] +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: arduino/arduino-lint-action@v1 diff --git a/README.md b/README.md index c371c0c..4824318 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # AgIsoStack-Arduino AgIsoStack is a free ISOBUS (ISO11783) and SAE J1939 compatible CAN stack that makes communication on off-highway vehicle CAN networks easy. -Currently this library is compatible with Teensy hardware only. ESP32 support will likely be added at some point, but for now PlatformIO + ESP-IDF is supported for ESP32 platforms via the [main repo](https://github.com/Open-Agriculture/AgIsoStack-plus-plus). +This library is based on the larger [AgIsoStack++ project](https://github.com/Open-Agriculture/AgIsoStack-plus-plus), which provides a CMake build system and additional supported CAN hardware. + +Currently this Arduino library is compatible with Teensy hardware only. ESP32 support will likely be added at some point, but for now PlatformIO + ESP-IDF is supported for ESP32 platforms via the [main repo](https://github.com/Open-Agriculture/AgIsoStack-plus-plus). ### Features