Merge remote-tracking branch 'gkoh/master' into add-interval

.github/workflows/main.yml

@@ -10,22 +10,36 @@ on:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
+  format:
     runs-on: ubuntu-latest
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v3
 
       - name: Run clang-format style check
         uses: jidicula/[email protected]
         with:
           clang-format-version: '13'
           check-path: '.'
-          exclude-regex: 'lib/M5ez'
+          exclude-regex: 'lib/M5ez/examples'
+
+  # This workflow contains a matrix of build platforms
+  build:
+    strategy:
+      matrix:
+        platform:
+          - m5stick-c
+          - m5stick-c-plus
+          - m5stack-core
+          - m5stack-core2
+
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
 
       - name: Setup Python
         uses: actions/setup-python@v4
@@ -37,11 +51,13 @@ jobs:
         run: |
           pip install -r requirements.txt
 
-      - name: Build furble (M5StickC)
-        run: platformio run -e m5stick-c
-
-      - name: Build furble (M5StickC Plus)
-        run: platformio run -e m5stick-c-plus
+      - name: Build furble (${{ matrix.platform }})
+        run: platformio run -e ${{ matrix.platform }}
 
-      - name: Build furble (M5Stack Core2)
-        run: platformio run -e m5stack-core2
+  success:
+    runs-on: ubuntu-latest
+    needs:
+      - format
+      - build
+    steps:
+      - run: echo "Success"!

.github/workflows/release.yml

@@ -9,6 +9,7 @@ env:
   FURBLE_VERSION: ${{ github.ref_name }}+${{ github.run_attempt }}
   M5STICKC_FIRMWARE: furble-m5stick-c-${{ github.ref_name }}+${{ github.run_attempt }}.bin
   M5STICKC_PLUS_FIRMWARE: furble-m5stick-c-plus-${{ github.ref_name }}+${{ github.run_attempt }}.bin
+  M5STACK_CORE_FIRMWARE: furble-m5stack-core-${{ github.ref_name }}+${{ github.run_attempt }}.bin
   M5STACK_CORE2_FIRMWARE: furble-m5stack-core2-${{ github.ref_name }}+${{ github.run_attempt }}.bin
 
 jobs:
@@ -40,14 +41,19 @@ jobs:
           platformio run -e m5stick-c-plus
           cp -v .pio/build/m5stick-c-plus/firmware.bin $M5STICKC_PLUS_FIRMWARE
 
+      - name: Build furble (M5Stack Core)
+        run: |
+          platformio run -e m5stack-core
+          cp -v .pio/build/m5stack-core/firmware.bin $M5STACK_CORE_FIRMWARE
+
       - name: Build furble (M5Stack Core2)
         run: |
           platformio run -e m5stack-core2
           cp -v .pio/build/m5stack-core2/firmware.bin $M5STACK_CORE2_FIRMWARE
 
       - name: Generate release hashes
         run: |
-          sha256sum $M5STICKC_FIRMWARE $M5STICKC_PLUS_FIRMWARE $M5STACK_CORE2_FIRMWARE > sha256sum.txt
+          sha256sum $M5STICKC_FIRMWARE $M5STICKC_PLUS_FIRMWARE $M%M5STACK_CORE_FIRMWARE $M5STACK_CORE2_FIRMWARE > sha256sum.txt
 
       - name: Release
         uses: softprops/action-gh-release@v1
@@ -56,5 +62,6 @@ jobs:
           files: |
             ${{ env.M5STICKC_FIRMWARE }}
             ${{ env.M5STICKC_PLUS_FIRMWARE }}
+            ${{ env.M5STACK_CORE_FIRMWARE }}
             ${{ env.M5STACK_CORE2_FIRMWARE }}
             sha256sum.txt

.gitignore

@@ -1,4 +1,3 @@
 .pio
 .vscode
-
-src/furble.ino.cpp
+src/furble.ino.cpp

README.md

@@ -111,6 +111,13 @@ the following libraries:
 
 ## Installation
 
+### Easy Install
+
+The simplest way to get started is using `esphome-flasher` and the release binaries.
+Follow the instructions on the wiki: [Easy Install](https://github.com/gkoh/furble/wiki/Easy-Install)
+
+### PlatformIO
+
 PlatformIO does everything assuming things are installed and connected properly.
 In most cases it should be:
 - clone the repository
@@ -121,6 +128,8 @@ In most cases it should be:
 - OR plug in the M5Stack Core2
     - `platformio run -e m5stack-core2 -t upload`
 
+More details are on the wiki: [PlatformIO](https://github.com/gkoh/furble/wiki/Linux-Command-Line-(For-Developers))
+
 ## Usage
 
 The top level menu has the following entries: