Skip to content

Update README.md

Update README.md #106

Workflow file for this run

name: Arduino
# Here we tell GitHub to run the workflow when a commit
# is pushed or a Pull Request is opened.
on: [push, pull_request]
# This is the list of jobs that will be run concurrently.
# Since we use a build matrix, the actual number of jobs
# started depends on how many configurations the matrix
# will produce.
jobs:
# This is the name of the job - can be whatever.
test-matrix:
# Here we tell GitHub that the jobs must be determined
# dynamically depending on a matrix configuration.
strategy:
matrix:
# The matrix will produce one job for each configuration
# parameter of type `arduino-platform`, in this case a
# total of 2.
arduino-platform: ["arduino:mbed_nano esp32:esp32"]
# This is usually optional but we need to statically define the
# FQBN of the boards we want to test for each platform. In the
# future the CLI might automatically detect and download the core
# needed to compile against a certain FQBN, at that point the
# following `include` section will be useless.
include:
- arduino-platform: "arduino:mbed_nano"
fqbn: "arduino:mbed_nano:nanorp2040connect"
- arduino-platform: "esp32:esp32"
fqbn: "esp32:esp32:esp32s3:JTAGAdapter=default,PSRAM=enabled,FlashMode=qio,FlashSize=4M,LoopCore=1,EventsCore=1,USBMode=hwcdc,CDCOnBoot=default,MSCOnBoot=default,DFUOnBoot=default,UploadMode=default,PartitionScheme=huge_app,CPUFreq=240,UploadSpeed=921600,DebugLevel=none,EraseFlash=none"
# This is the platform GitHub will use to run our workflow, we
# pick Windows for no particular reason.
runs-on: windows-latest
# This is the list of steps this job will run.
steps:
# First of all, we clone the repo using the `checkout` action.
- name: Checkout
uses: actions/checkout@v4
# We use the `arduino/setup-arduino-cli` action to install and
# configure the Arduino CLI on the system.
- name: Setup Arduino CLI
uses: arduino/setup-arduino-cli@v1
# We then install the platform, which one will be determined
# dynamically by the build matrix.
- name: Install platform
run: |
arduino-cli core update-index
arduino-cli core install ${{ matrix.arduino-platform }}
# Finally, we compile the sketch, using the FQBN that was set
# in the build matrix.
- name: Compile MainBoard Sketch
run: arduino-cli compile --fqbn ${{ matrix.fqbn }} ./Code/MainBoard_Pico/MainBoard_Pico.ino
- name: Compile Display Sketch
run: arduino-cli compile --fqbn ${{ matrix.fqbn }} ./Code/Display/Display.ino