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

Update README #69

Merged
merged 6 commits into from
Nov 25, 2022
Merged

Update README #69

merged 6 commits into from
Nov 25, 2022

Conversation

SergioGasquez
Copy link
Member

  • Update prerequisites
  • Update flash and build sections


- You **can** target the ESP32-C3 with the Espressif toolchains just fine, but this MCU is also supported by the stock compilers
- So alternatively - just use the stock nightly Rust compiler, and a recent, stock Clang (as in Clang 11+)
You need a Python 3.7 or later installed on your machine. Install it from the package distro of your OS, or download and install it [from the official Python site](https://www.python.org/downloads/).
Copy link
Collaborator

Choose a reason for hiding this comment

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

It seems to me that you have completely removed the wording where folks can just use the Rust nightly toolchain for esp32c* chips. Given that all new Espressif SOCs are riscv based, I think we should advertise and preserve the documentation for this option.

Copy link
Member Author

Choose a reason for hiding this comment

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

True, I just added the link to the book where we explain this, but it would be better to have it explicit.
35df5f5 should fix this

Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless there are good reasons not to, how about also restoring:

  • The Rustup installation guidelines; or else how are they going to call rustup toolchain?
  • The link to the Clang site.

Copy link
Member Author

Choose a reason for hiding this comment

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

You are right! Restored in 304ec34

Thanks for the feedback


- You **can** target the ESP32-C3 with the Espressif toolchains just fine, but this MCU is also supported by the stock compilers
- So alternatively - just use the stock nightly Rust compiler, and a recent, stock Clang (as in Clang 11+)
You need a Python 3.7 or later installed on your machine. Install it from the package distro of your OS, or download and install it [from the official Python site](https://www.python.org/downloads/).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Unless there are good reasons not to, how about also restoring:

  • The Rustup installation guidelines; or else how are they going to call rustup toolchain?
  • The link to the Clang site.

@SergioGasquez SergioGasquez merged commit 02499f6 into esp-rs:master Nov 25, 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.

2 participants