Skip to content
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

NF: add an IDE help #481

Merged
merged 2 commits into from
May 2, 2024
Merged

NF: add an IDE help #481

merged 2 commits into from
May 2, 2024

Conversation

Arthur-Milchior
Copy link
Contributor

I had some troubles using IntelliJ to work with the code examples. I thus added a page that tries to help the user getting the best out of their IDE with this book.

Some of the solution are not IntelliJ specific, so I separated this page into a general purpose help and a section that concern specific IDE.

Since I only use IntelliJ, I can't provide section for Code, for examples. So, I invited users of other IDE to contribute.

Ideally, I'd love for someone to get how to use the debugger with the IDE too. However, even if this page is not perfect, I believe it may still be an improvement for the next reader

@rust-highfive
Copy link

r? @andre-richter

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-resources labels Nov 12, 2022
Copy link
Member

@eldruin eldruin left a comment

Choose a reason for hiding this comment

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

Thanks for the suggestion.
Here some improvements / corrections.

@hargoniX could you also check on this? especially the part about removing dependencies/features

microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
microbit/src/03-setup/IDE.md Outdated Show resolved Hide resolved
Copy link
Member

@BartMassey BartMassey left a comment

Choose a reason for hiding this comment

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

There's some grammar that needs a bit of cleaning up here: can provide specifics on request.

After that, this should be merged.

@eldruin
Copy link
Member

eldruin commented May 1, 2024

@BartMassey a more in-depth review would indeed be welcome.

Copy link
Member

@BartMassey BartMassey left a comment

Choose a reason for hiding this comment

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

I had missed this commit. Looks great now.

Copy link
Member

@eldruin eldruin 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!

@eldruin eldruin enabled auto-merge May 2, 2024 06:20
@eldruin eldruin added this pull request to the merge queue May 2, 2024
Merged via the queue into rust-embedded:master with commit 70fc662 May 2, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-resources
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants