Skip to content

doc: Update readme #609

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

Merged
finger563 merged 1 commit into from
Feb 28, 2026
Merged

doc: Update readme #609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ To use the components in this repository, you have a few options:
1. You can clone espp somewhere on your computer and then point your project to
its `components` directory to use any of the components it contains, similar
to the step above.

Copy link

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

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

Line 79 contains whitespace on an otherwise blank line. Consider removing the trailing spaces to avoid noisy diffs and potential markdown formatting/lint issues.

Suggested change

Copilot uses AI. Check for mistakes.
Note: you should ensure that you clone recursively or run `git submodule
update --init --recursive` to ensure that you have the latest versions of all
the submodules which are required to build the components in this repository.
Comment on lines +80 to +82
Copy link

Copilot AI Feb 28, 2026

Choose a reason for hiding this comment

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

The note about submodules is a bit misleading/inconsistent: git submodule update --init --recursive checks out the commits pinned by this repo (not necessarily the "latest" versions from submodule remotes), and "clone recursively" would be clearer as git clone --recurse-submodules. Also consider matching the existing capitalization/style used elsewhere in this README (e.g., "NOTE:").

Suggested change
Note: you should ensure that you clone recursively or run `git submodule
update --init --recursive` to ensure that you have the latest versions of all
the submodules which are required to build the components in this repository.
NOTE: you should ensure that you clone with submodules, for example by using
`git clone --recurse-submodules`, or, if you have already cloned the
repository, by running `git submodule update --init --recursive` to ensure
that all required submodules are checked out at the commits pinned by this
repository.

Copilot uses AI. Check for mistakes.

## Additional Information and Links

Expand Down