Skip to content

Conversation

Serjlee
Copy link
Contributor

@Serjlee Serjlee commented Sep 7, 2022

Motivation

Users stumbling on this repository should be able to quickly start using the tool after reading the README

Change description

  • Add link to releases page
  • Add header to each listed command
  • Use codeblocks for CLI examples (as they highlight the parameters and are easier to copy)
  • Lint README with markdownlint

Additional Notes

Reviewer checklist

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

@Serjlee Serjlee requested review from polldo and rsora September 7, 2022 10:22
Co-authored-by: Paolo Calao <paolo.calao@gmail.com>
Copy link

@rsora rsora left a comment

Choose a reason for hiding this comment

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

I added a couple of cosmetic suggestion and a couple of pointers to the Arduino documentation. The rest is excellent!

Co-authored-by: Roberto Sora <r.sora@arduino.cc>
@Serjlee
Copy link
Contributor Author

Serjlee commented Sep 8, 2022

Thanks for the suggestions guys!

@Serjlee Serjlee requested a review from rsora September 8, 2022 15:57
@Serjlee Serjlee merged commit 52779c6 into main Sep 9, 2022
@Serjlee Serjlee deleted the serjlee/update-readme branch September 9, 2022 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants