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.

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

Update example READMEs #61

Closed
2 tasks done
finger563 opened this issue May 26, 2023 · 0 comments · Fixed by #65
Closed
2 tasks done

Update example READMEs #61

finger563 opened this issue May 26, 2023 · 0 comments · Fixed by #65
Labels
documentation Improvements or additions to documentation examples

Comments

@finger563
Copy link
Contributor

Answers checklist.

  • I have read the documentation README and the issue is not addressed there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

Right now the example READMEs are all templates without any useful information. Since most of the examples have associated documentation (images / videos / text) on their associated PRs, it would be good to move some of that information over to the READMEs themselves for people who are browsing the repo and learning how to run the examples / use the components.
@finger563 finger563 added documentation Improvements or additions to documentation examples labels May 26, 2023
finger563 added a commit that referenced this issue Jun 4, 2023
@finger563
doc: update
0771700 
* Removed template readmes for examples and replaced with short descriptions and instructions
closes #61
@finger563 finger563 mentioned this issue Jun 4, 2023
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation examples
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: update - Added READMEs to each example esp-cpp/espp
1 participant
@finger563