Skip to content

doc: Update readme#609

Merged
finger563 merged 1 commit intomainfrom
readme/update
Feb 28, 2026
Merged

doc: Update readme#609
finger563 merged 1 commit intomainfrom
readme/update

Conversation

@finger563
Copy link
Contributor

No description provided.

Copilot AI review requested due to automatic review settings February 28, 2026 21:00
@finger563 finger563 merged commit 32e8215 into main Feb 28, 2026
7 of 9 checks passed
@finger563 finger563 deleted the readme/update branch February 28, 2026 21:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the top-level README to clarify how to properly obtain required git submodules when using this repo’s components.

Changes:

  • Adds a note under “Getting Started” explaining recursive cloning / initializing submodules.

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.
Comment on lines +80 to +82
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.
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants