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 to match with unification changes #1217

Merged
merged 3 commits into from
Feb 28, 2024

Conversation

JurajSadel
Copy link
Contributor

Thank you!

Thank you for your contribution.
Please make sure that your submission includes the following:

Must

  • The code compiles without errors or warnings.
  • All examples work.
  • cargo fmt was run.
  • Your changes were added to the CHANGELOG.md in the proper section.
  • You updated existing examples or added examples (if applicable).
  • Added examples are checked in CI

Nice to have

  • You add a description of your work to this PR.
  • You added proper docs for your newly added features and code.

Removes the references to chip-specific HALs and briefly describes crates inside esp-hal. Also, for now, removes esp-hal documentation links.

closes #1209

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jessebraham jessebraham added the skip-changelog No changelog modification needed label Feb 28, 2024
@JurajSadel JurajSadel marked this pull request as ready for review February 28, 2024 16:17
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.

A typo to fix, but LGTM. I'll let others chime in with regards to the content before merging.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Thanks!

@jessebraham jessebraham added this pull request to the merge queue Feb 28, 2024
Merged via the queue into esp-rs:main with commit 5b57709 Feb 28, 2024
1 check passed
@jessebraham jessebraham mentioned this pull request Feb 28, 2024
4 tasks
@JurajSadel JurajSadel deleted the docs branch February 28, 2024 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Top-level README.md file needs updating to remove references to chip-specific HAL packages
4 participants