Update README.md #127

2026-02-05T22:44:57+08:00

ajkrj commented

2026-02-05 22:44:57 +08:00

(Migrated from https://github.com/polhenarejos/pico-hsm)

Summary

This PR corrects the sequence of commands in the build instructions within README.md.

What problem does it solve? It moves the git submodule update command to occur after changing into the project directory (cd pico-hsm). Previously, the instructions attempted to update submodules from the parent directory, which would fail.
Is it a bug fix, a new feature, a cleanup/refactor…? Bug fix (documentation logic).

Details / Impact

Please include any relevant details:

Hardware / board(s) tested: N/A (Documentation fix).
Firmware / commit/base version: N/A.
Security impact (if any): None.
Behavior changes: Corrects the installation flow so users can successfully initialize submodules.

Testing

How did you test this change?

Steps to reproduce / validate: Verified that git submodule update --init --recursive requires being inside a git repository to execute correctly.
Expected vs actual results: - Actual (Old): Command fails because it's executed in the parent directory.
Expected (New): Command executes successfully within the pico-hsm folder.

Licensing confirmation (required)

By checking the box below, you confirm ALL of the following:

Yes, I agree (You are the author, you've read CONTRIBUTING.md, and you agree to the AGPLv3/Commercial licensing terms).

Anything else?

Minor fix to ensure the "Getting Started" instructions work as written.

## Summary This PR corrects the sequence of commands in the build instructions within `README.md`. * **What problem does it solve?** It moves the `git submodule update` command to occur after changing into the project directory (`cd pico-hsm`). Previously, the instructions attempted to update submodules from the parent directory, which would fail. * **Is it a bug fix, a new feature, a cleanup/refactor…?** Bug fix (documentation logic). ## Details / Impact Please include any relevant details: * **Hardware / board(s) tested:** N/A (Documentation fix). * **Firmware / commit/base version:** N/A. * **Security impact (if any):** None. * **Behavior changes:** Corrects the installation flow so users can successfully initialize submodules. ## Testing How did you test this change? * **Steps to reproduce / validate:** Verified that `git submodule update --init --recursive` requires being inside a git repository to execute correctly. * **Expected vs actual results:** - **Actual (Old):** Command fails because it's executed in the parent directory. * **Expected (New):** Command executes successfully within the `pico-hsm` folder. ## Licensing confirmation (required) By checking the box below, you confirm ALL of the following: * [x] **Yes, I agree** (You are the author, you've read `CONTRIBUTING.md`, and you agree to the AGPLv3/Commercial licensing terms). ## Anything else? Minor fix to ensure the "Getting Started" instructions work as written.

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin ajkrj/patch-1:ajkrj/patch-1

git checkout ajkrj/patch-1

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: dearsky/pico-hsm#127