Skip to content

ESP32-S2: Fix readme link, improve instruction clarity #3607

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 26, 2020
Merged

ESP32-S2: Fix readme link, improve instruction clarity #3607

merged 1 commit into from
Oct 26, 2020

Conversation

hierophect
Copy link
Collaborator

PR #3487 introduced some changes to the ESP32-S2 readme clarifying our temporary use of a forked ESP-IDF, and was understandably derailed when we switched over to the Espressif IDF in #3492 and #3519. This PR recreates a couple of small but important fixes from that PR:

  • Fix the ESP-IDF link so it points to the correct documentation page (link was erroneously for ESP32, not ESP32-S2).
  • Note that you must add environmental variables to your path after installing for the first time.

@hierophect hierophect added documentation espressif applies to multiple Espressif chips labels Oct 26, 2020
@hierophect hierophect requested a review from jepler October 26, 2020 15:16
@hierophect hierophect mentioned this pull request Oct 26, 2020
Closed
@hierophect
Copy link
Collaborator Author

CI didn't actually fail here, seems like a QTPi problem

@hierophect hierophect requested a review from tannewt October 26, 2020 17:35
jepler
jepler approved these changes Oct 26, 2020
View reviewed changes
Copy link

@jepler jepler left a comment

Choose a reason for hiding this comment

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

LGTM. CI failure was network pixies having inadequate pixie dust

@jepler jepler merged commit caca060 into adafruit:main Oct 26, 2020
@hierophect hierophect added the Hacktoberfest Beginner friendly issues for Hacktoberfest event label Oct 26, 2020
@hierophect hierophect deleted the esp32-readme-clarity branch November 24, 2020 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jepler jepler jepler approved these changes

@tannewt tannewt Awaiting requested review from tannewt

Assignees
No one assigned
Labels
documentation espressif applies to multiple Espressif chips Hacktoberfest Beginner friendly issues for Hacktoberfest event
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hierophect @jepler