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

Devcontainer support, update instructions and environment #1

Merged
merged 12 commits into from
Aug 6, 2022
Merged

Devcontainer support, update instructions and environment #1

merged 12 commits into from
Aug 6, 2022

Conversation

SergioGasquez
Copy link
Contributor

Hi! Thanks for your effort in bringing Rust to the MCH Badge! Here is a PR that includes:

  • Adds devcontainer support to bootstrap the environment (we can even develop ESP boards in Rust in a browser app without installing anything 🤯 )
    • Devcontainers in VsCode
    • Gitpod: Open ESP32 in Gitpod
      • The button on the readme would need to be updated if this PR gets merged as it's currently pointing to my fork
    • GitHub Codespaces
  • Wokwi simulation: Since the board was already in Wokwi I was able to use it and simulate Rust code on it, using wokwi-server.
    • Wokwi also supports GDB debugging, so I included launch.json with the necessary configuration to debug the project from devcontainers
  • Add some task to build, and run Wokwi simualtions from devcontainers
  • Add some task to build and flash from host machine
  • Updated the readme:
    • Updated installation commands
      • We don't need rustup override set esp as we have rust-toolchain.toml specifying our channel
      • You can install esp-idf while installing Xtensa Rust toolchain, which will avoid downloading the whole internet while building the project for the first time, and can also be reused in other projects (the other way your would end up having the whole internet several times on your machine, which eats a lot of space)
        • Deleted .embuild directory (is where esp-idf gets downloaded if you don't have it installed and activated)
      • There is an argument on Xtensa installer which creates an export file, which you can later source to setup all the environment variables required.
    • Devcontainers documentation

README.md Outdated
select `Build & Flash`.
- From UI: Press `Build & Flash` on the left side of the Status Bar.
- Any alternative flashing method from host machine.

Copy link
Owner

Choose a reason for hiding this comment

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

I think all these approaches would remove the launcher program provided with the badge?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello @p2mate! Sorry for the late reply, I was ooo. You are correct, just deleted this paragraph!

@p2mate p2mate merged commit bf8e5c6 into p2mate:main Aug 6, 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