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

Added the README template for examples and libraries #5228

Merged
merged 2 commits into from
Jun 9, 2021
Merged

Added the README template for examples and libraries #5228

merged 2 commits into from
Jun 9, 2021

Conversation

pedrominatel
Copy link
Member

Added the README template to be used on the ESP32 examples and libraries.

@pedrominatel pedrominatel added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label May 31, 2021
@pedrominatel pedrominatel self-assigned this May 31, 2021

#### Using Arduino IDE

* Before Compile/Verify, select the correct board: `Tools -> Board`.
Copy link
Contributor

Choose a reason for hiding this comment

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

What about adding here a link to Development Board overview? Users will be sure about main specification of their Board as Flash/PSRAM and also selected correct one if they are not sure.

[https://www.espressif.com/en/products/devkits]

Copy link
Member

Choose a reason for hiding this comment

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

@pedrominatel are you going to adjust this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done!

Typos fixed and added more details and instructions
Added README file to WiFiScan example
Review on the README template
Added link to DevKits
@me-no-dev me-no-dev merged commit 2382087 into espressif:master Jun 9, 2021
@VojtechBartoska VojtechBartoska linked an issue Jun 14, 2021 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create README.md template for examples
3 participants