Skip to content

Improve readme and add flag to turn debug info ON for libmbed #497

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

Merged
merged 6 commits into from
Jun 13, 2022

Conversation

facchinm
Copy link
Member

@facchinm facchinm commented Jun 8, 2022

No description provided.

@facchinm facchinm requested a review from aentinger June 8, 2022 13:32
@facchinm
Copy link
Member Author

facchinm commented Jun 8, 2022

@per1234 if you could give a grammar/quality check it would be great ❤️

@aentinger
Copy link
Contributor

Looks to me like @per1234 already had a field day. I'll wait with my review until his suggestions have been resolved.

One thing I can say already is that if the intention is to provide information on how to create a debuggable build the text would need to be restructured a bit, like having a headline: "How to enable debugging for ArduinoCore-mbed based boards". I felt that although I personally know what to look for it was not that easy for me to extract that information.

Co-authored-by: per1234 <[email protected]>
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

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

All good now from a nitpick standpoint. I don't have time now to evaluate in detail it from a technical standpoint, but I think this is a very nice enhancement over the previous documentation and script.

Thanks Martino!

@aentinger
Copy link
Contributor

That's my take on improving the issue I mentioned above. What do you guys think?

@per1234
Copy link
Contributor

per1234 commented Jun 9, 2022

Looks good to me.

@facchinm
Copy link
Member Author

facchinm commented Jun 9, 2022

@aentinger thanks for the patch, it was much needed! I pushed another commit to explain how to change the project config file, hope it's clear enough

People arriving at the README can then follow the bread-crumbs to the more comprehensive documentation.
@facchinm facchinm merged commit 1d0256e into arduino:master Jun 13, 2022
Copy link
Contributor

@manchoz manchoz left a comment

Choose a reason for hiding this comment

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

LGTM, too

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.

4 participants