diff --git a/README.md b/README.md index 792e8904..be7392d2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/REPRODUCIBLE.md b/REPRODUCIBLE.md index 47a7c5c9..39010a6e 100755 --- a/REPRODUCIBLE.md +++ b/REPRODUCIBLE.md @@ -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. @@ -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 ```