Skip to content

Update README with instructions about dependency from 'arduino-cli' #137

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

Conversation

csarnataro
Copy link
Contributor

Update README with instructions about dependency from 'arduino-cli' to create a device

Motivation

The creation of a device requires the arduino-cli installed, but this is not stated anywhere in the docs.
The documentation should be improved to reflect this dependency.

Change description

Updated README file with the proposed improvements.

Additional Notes

Closes #136

Reviewer checklist

  • PR address a single concern.
  • PR title and description are properly filled.
  • Changes will be merged in main.
  • [N/A] Changes are covered by tests.
  • [N/A] Logging is meaningful in case of troubleshooting.
  • History is clean, commit messages are meaningful (see CONTRIBUTING.md) and are well formatted.

@csarnataro csarnataro requested review from robgee86 and mirkokurt May 5, 2023 18:40
@per1234 per1234 added the documentation Improvements or additions to documentation label May 12, 2023
Fixed URL of Arduino CLI Homepage, from a specific version to the 'latest' redirect
Fixed URL of Arduino CLI installation instructions. Amends a previous incomplete fix.
Copy link
Contributor

@robgee86 robgee86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @csarnataro and @per1234!

Copy link
Collaborator

@mirkokurt mirkokurt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙏

@mirkokurt mirkokurt merged commit 3f024b0 into arduino:main May 12, 2023
@per1234 per1234 added the enhancement New feature or request label Sep 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve docs to clarify that for some command the arduino-cli is a pre-requisite
4 participants