Skip to content

Provide an introductory tutorial for the Arduino boards platform system #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
per1234 opened this issue Jul 21, 2020 · 0 comments
Open
Assignees
Labels
criticality: medium Of moderate impact topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@per1234
Copy link
Contributor

per1234 commented Jul 21, 2020

Describe the request

Create an introductory tutorial that guides the user through the basic process of creating an Arduino boards platform.

Although the creation of a standalone platform from scratch is a very involved and complex endeavor, the referencing capabilities of the platform framework allow the creation of platforms that may consist of as little as a handful of lines in a boards.txt file, referencing the other components from existing platforms. The tutorial can demonstrate the creation of one of these referencing platforms. These minimal platforms can be very useful even to users who only want to make some minor changes to an existing platform.

🙂 This tutorial would serve as an entry point for aspiring platform developers.

🙂 After they gain an overview of the platform system from the tutorial, the Arduino Platform Specification can by used by the developer as a reference to be consulted for more information on specific topics as needed, rather than having to slog through the entire specification before they can get started.

Describe the current behavior

The Arduino Platform Specification provides a comprehensive reference of the Arduino boards platform framework.

🙁 For a casual developer with no prior knowledge of Arduino platforms, this document will likely present a steep learning curve.

Arduino CLI version

Any

Operating system

All

Additional context

The simple platform from the tutorial could be published as an example to accompany it.

Related

@per1234 per1234 added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Jul 21, 2020
@per1234 per1234 reopened this Mar 30, 2021
@rsora rsora added the priority: medium Resolution is a medium priority label Oct 21, 2021
@rsora rsora added criticality: medium Of moderate impact and removed priority: medium Resolution is a medium priority labels Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
criticality: medium Of moderate impact topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants