Skip to content

Commit

Permalink
docs: fix minor errors in REPRODUCIBLE.md and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
akarve authored and JamieDriver committed Apr 9, 2024
1 parent 7ea1603 commit 54c5067
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ At this point the Jade fw running in the qemu emulator should be available on 't

# Reproducible Build

See REPRODUCIBLE.md for instructions on locally reproducing the official Blockstream Jade firmware images (minus the Blockstream signature block).
See [REPRODUCIBLE.md](./REPRODUCIBLE.md) for instructions on locally reproducing the official Blockstream Jade firmware images (minus the Blockstream signature block).

# License

Expand Down
8 changes: 7 additions & 1 deletion REPRODUCIBLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

The following assumes the jade repo is cloned, checked-out to the appropriate release tag, and all submodules updated.

> To initalize and update submodules, run the following:
> ```
> git submodule init
> git submodule update
> ```
NOTE: DO NOT TRY TO FLASH OR OTA THESE BUILD ARTIFACTS ONTO A JADE OR ANY OTHER ESP32 HARDWARE.
They contain settings to encrypt the flash and to enable 'secure boot' - this burns 'efuses' on the device - a one-way operation, and may render the device unusable.
Expand Down Expand Up @@ -51,7 +57,7 @@ eg:
cp ./production/sdkconfig_jade_prod.defaults sdkconfig.defaults
rm -f sdkconfig
```
NOTE: The `rm -f sdkconfig` step is not necessary on a fresh/clean repo, but always best to ensure this file does not exist and is recreated from the `sdkconfig.defaults` file. This is vital if the `skconfig.defaults` file is changed (eg. to build another configuration).
NOTE: The `rm -f sdkconfig` step is not necessary on a fresh/clean repo, but always best to ensure this file does not exist and is recreated from the `sdkconfig.defaults` file. This is vital if the `sdkconfig.defaults` file is changed (eg. to build another configuration).
5. Build
```
Expand Down

0 comments on commit 54c5067

Please sign in to comment.