Skip to content

Feature Request: Add Comprehensive Examples for Sketch Compilation #419

@grasmarcussanti129

Description

@grasmarcussanti129

Summary

Currently, the arduino/compile-sketches action documentation does not provide detailed examples demonstrating how to compile various types of Arduino sketches. Including a range of examples would help users understand how to effectively utilize the action for different sketch configurations.

Proposal

I suggest adding a section in the README that includes:

  • Simple examples for basic sketches.
  • Complex examples for projects that involve multiple libraries and dependencies.
  • A brief explanation of any key options that can be passed to the action.

These examples will assist users in troubleshooting common issues and applying the action more effectively to their projects.

Benefits

  • Enhances usability of the action.
  • Reduces the likelihood of user errors.
  • Encourages broader adoption by demonstrating capability in real-world scenarios.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions