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

Book update #37

Merged
merged 35 commits into from
Oct 31, 2022
Merged

Book update #37

merged 35 commits into from
Oct 31, 2022

Conversation

SergioGasquez
Copy link
Member

  • Update dependencies chapter
  • Add simulating chapter
  • Update writing your own application chapter
  • Add resources chapter

I still need to review my changes with more detail but I would like some input (organization of the content, wording... any feedback is welcome)

@SergioGasquez SergioGasquez marked this pull request as ready for review October 31, 2022 12:18
@SergioGasquez SergioGasquez linked an issue Oct 31, 2022 that may be closed by this pull request
Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

LGTM!

src/dependencies/index.md Outdated Show resolved Hide resolved
Copy link
Member

@jessebraham jessebraham left a comment

Choose a reason for hiding this comment

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

This looks really good overall, thank you for the updates! I just left a couple comments, please feel free to address them in separate PRs or ignore them altogether.

src/installation/index.md Outdated Show resolved Hide resolved
Comment on lines +1 to +7
# Simulating

Simulating projects can be very handy. It allows users to test projects using CI, try projects without having hardware available, and many other scenarios.

At the moment, there are a few ways of simulating Rust projects on Espressif chips, all of them have some limitations, but it's quickly evolving and getting better every day.

In this chapter, we will discuss the different ways of simulation that are available.
Copy link
Member

Choose a reason for hiding this comment

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

Given the brevity of the Wokwi and QEMU sections, maybe those two pages can just be combined into this one? If there are plans to expand on those other two sections this may not make sense, but they seem to just delegate to other documentation.

Copy link
Member Author

Choose a reason for hiding this comment

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

I will like to expand them, I can probably improve Wokwi page and I will probably ask for help regarding QEMU

Copy link
Member

Choose a reason for hiding this comment

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

Okay sounds good, disregard then!

@jessebraham jessebraham merged commit ff89b52 into esp-rs:main Oct 31, 2022
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.

The Installing Rust section should be updated to use espup
3 participants