-
-
Notifications
You must be signed in to change notification settings - Fork 16
Open
Labels
topic: documentationRelated to documentation for the projectRelated to documentation for the projecttype: enhancementProposed improvementProposed improvement
Description
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
topic: documentationRelated to documentation for the projectRelated to documentation for the projecttype: enhancementProposed improvementProposed improvement