From 2005fd62b11c36e3726187fb5ce142ac60e375d3 Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Thu, 14 Sep 2023 23:04:02 -0400 Subject: [PATCH 1/7] Update README to point to SeedSigner OS build instructions and differentiate from the older Raspberry Pi OS build instructions. --- README.md | 16 +++++++++++----- ....md => raspberry_pi_os_build_instructions.md} | 4 +++- 2 files changed, 14 insertions(+), 6 deletions(-) rename docs/{manual_installation.md => raspberry_pi_os_build_instructions.md} (97%) diff --git a/README.md b/README.md index 407d8b3bf..5ab95d80c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ * [Verifying the Software](#verifying-the-software) * [Enclosure Designs](#enclosure-designs) * [SeedQR Printable Templates](#seedqr-printable-templates) -* [Manual Installation Instructions](#manual-installation-instructions) +* [Developer Build Instructions](#developer-build-instructions) +* [Build from Source](#build-from-source) --------------- @@ -82,9 +83,11 @@ Notes: # Software Installation ## A Special Note On Minimizing Trust -As is the nature of pre-packaged software downloads, downloading and using the prepared SeedSigner release images means implicitly placing trust in the individual preparing those images; in our project the release images are prepared and signed by the eponymous creator of the project, SeedSigner "the person". That individual is additionally the only person in possession of the PGP keys that are used to sign the release images. +As is the nature of pre-packaged software downloads, downloading and using the prepared SeedSigner release images means implicitly placing trust in the people preparing those images; in our project the release images are prepared and signed by the eponymous creator of the project, SeedSigner "the person". That individual is additionally the only person in possession of the PGP keys that are used to sign the release images. -However, one of the many advantages of the open source software model is that the need for this kind of trust can be negated by our users' ability to (1) review the project's source code and (2) assemble the operating image necessary to use the software themselves. From our project's inception, instructions to build a SeedSigner operating image (using precisely the same process that is used to create the prepared release images) have been made available. We have put a lot of thought and work into making these instructions easy to understand and follow, even for less technical users. These instructions can be found [here](docs/manual_installation.md). +As of release 0.7.0 the image released are reproducible. This means you and others can verify the released images are byte for byte that same when built from source. If you have the ability to read and understand source code; then you can contribute to this project by building from source and sharing the hash of the final images. + +Instructions to build a SeedSigner OS image (using precisely the same process that is used to create the prepared release images) have been made available. We have put a lot of thought and work into making these instructions easy to understand and follow, even for less technical users. These instructions can be found [here](https://github.com/SeedSigner/seedsigner-os/blob/main/docs/building.md). ## Downloading the Software @@ -326,5 +329,8 @@ Letter templates(8.5in * 11in): * [29x29 - stores 24-word seeds ONLY as plaintext SeedQR format ONLY](docs/seed_qr/printable_templates/29x29_letter_trading_card_2sided.pdf) --------------- -# Manual Installation Instructions -see the docs: [Manual Installation Instructions](docs/manual_installation.md) +# Developer Build Instructions +Raspberry Pi OS is commonly used for development. See the [Raspberry Pi OS Build Instructions](docs/raspberry_pi_os_build_instructions.md) + +# Build from Source +See the [SeedSigner OS repo](https://github.com/SeedSigner/seedsigner-os/) for instructions. \ No newline at end of file diff --git a/docs/manual_installation.md b/docs/raspberry_pi_os_build_instructions.md similarity index 97% rename from docs/manual_installation.md rename to docs/raspberry_pi_os_build_instructions.md index 17dbc975e..eba85cc1e 100644 --- a/docs/manual_installation.md +++ b/docs/raspberry_pi_os_build_instructions.md @@ -1,4 +1,6 @@ -# Manual Installation Instructions +# Raspberry Pi OS Build Instructions + +The released version of [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) does not use Raspberry Pi OS since version 0.6.0. These build instructions (previously referred to as "Manual Installation Instructions") are most commonly used by projects contributors looking to do rapid development cycles and testing to app code. If this is what you'd like to do, then continue reading. Begin by acquiring the latest 32-bit, Buster-based Raspberry Pi Lite operating system. This guide was tested using the version dated 2023-05-03; which can be found here: From 394eb46a8f42c5bf283ef77b2ae67ee3dea38af8 Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Fri, 15 Sep 2023 00:21:03 -0400 Subject: [PATCH 2/7] Fix typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5ab95d80c..ab817f529 100644 --- a/README.md +++ b/README.md @@ -83,9 +83,9 @@ Notes: # Software Installation ## A Special Note On Minimizing Trust -As is the nature of pre-packaged software downloads, downloading and using the prepared SeedSigner release images means implicitly placing trust in the people preparing those images; in our project the release images are prepared and signed by the eponymous creator of the project, SeedSigner "the person". That individual is additionally the only person in possession of the PGP keys that are used to sign the release images. +As is the nature of pre-packaged software downloads, downloading and using the prepared SeedSigner release images means implicitly placing trust in the people preparing those images; in our project the released images are prepared and signed by the eponymous creator of the project, SeedSigner "the person". That individual is additionally the only person in possession of the PGP keys that are used to sign the release images. -As of release 0.7.0 the image released are reproducible. This means you and others can verify the released images are byte for byte that same when built from source. If you have the ability to read and understand source code; then you can contribute to this project by building from source and sharing the hash of the final images. +As of release 0.7.0 the images distributed via GitHub are reproducible. This means you and others can verify the released images are byte for byte the same when built from source. If you have the ability to read and understand source code; then you can contribute to this project by building from source and sharing the hash of the final images. Instructions to build a SeedSigner OS image (using precisely the same process that is used to create the prepared release images) have been made available. We have put a lot of thought and work into making these instructions easy to understand and follow, even for less technical users. These instructions can be found [here](https://github.com/SeedSigner/seedsigner-os/blob/main/docs/building.md). @@ -333,4 +333,4 @@ Letter templates(8.5in * 11in): Raspberry Pi OS is commonly used for development. See the [Raspberry Pi OS Build Instructions](docs/raspberry_pi_os_build_instructions.md) # Build from Source -See the [SeedSigner OS repo](https://github.com/SeedSigner/seedsigner-os/) for instructions. \ No newline at end of file +See the [SeedSigner OS repo](https://github.com/SeedSigner/seedsigner-os/) for instructions. From 1fa3f806789dd57c3d5b7716fa7474d4bf12ad42 Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Fri, 15 Sep 2023 00:22:36 -0400 Subject: [PATCH 3/7] fix type --- docs/raspberry_pi_os_build_instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/raspberry_pi_os_build_instructions.md b/docs/raspberry_pi_os_build_instructions.md index eba85cc1e..a0723c73c 100644 --- a/docs/raspberry_pi_os_build_instructions.md +++ b/docs/raspberry_pi_os_build_instructions.md @@ -1,6 +1,6 @@ # Raspberry Pi OS Build Instructions -The released version of [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) does not use Raspberry Pi OS since version 0.6.0. These build instructions (previously referred to as "Manual Installation Instructions") are most commonly used by projects contributors looking to do rapid development cycles and testing to app code. If this is what you'd like to do, then continue reading. +The released version of [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) does not use Raspberry Pi OS since version 0.6.0. These build instructions (previously referred to as "Manual Installation Instructions") are most commonly used by project contributors looking to do rapid development cycles and testing to app code. If this is what you'd like to do, then continue reading. Begin by acquiring the latest 32-bit, Buster-based Raspberry Pi Lite operating system. This guide was tested using the version dated 2023-05-03; which can be found here: From 367d037406ee9bb965fb106d55d5c24bdcd20ffa Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Fri, 15 Sep 2023 00:24:43 -0400 Subject: [PATCH 4/7] fix more typos --- docs/raspberry_pi_os_build_instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/raspberry_pi_os_build_instructions.md b/docs/raspberry_pi_os_build_instructions.md index a0723c73c..59b3ee534 100644 --- a/docs/raspberry_pi_os_build_instructions.md +++ b/docs/raspberry_pi_os_build_instructions.md @@ -1,6 +1,6 @@ # Raspberry Pi OS Build Instructions -The released version of [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) does not use Raspberry Pi OS since version 0.6.0. These build instructions (previously referred to as "Manual Installation Instructions") are most commonly used by project contributors looking to do rapid development cycles and testing to app code. If this is what you'd like to do, then continue reading. +The released version of [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) does not use Raspberry Pi OS since version 0.6.0. These build instructions (previously referred to as "Manual Installation Instructions") are most commonly used by project contributors looking to do rapid development cycles. If this is what you'd like to do, then continue reading. Begin by acquiring the latest 32-bit, Buster-based Raspberry Pi Lite operating system. This guide was tested using the version dated 2023-05-03; which can be found here: From 3ca3174b05d8ac4085e8665223d9bab2c7eaf152 Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Fri, 12 Apr 2024 08:42:29 -0400 Subject: [PATCH 5/7] Update README.md minor edits from Keith --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ab817f529..54958c762 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ * [Verifying the Software](#verifying-the-software) * [Enclosure Designs](#enclosure-designs) * [SeedQR Printable Templates](#seedqr-printable-templates) -* [Developer Build Instructions](#developer-build-instructions) * [Build from Source](#build-from-source) +* [Developer Local Build Instructions](#developer-build-instructions) --------------- @@ -85,7 +85,7 @@ Notes: ## A Special Note On Minimizing Trust As is the nature of pre-packaged software downloads, downloading and using the prepared SeedSigner release images means implicitly placing trust in the people preparing those images; in our project the released images are prepared and signed by the eponymous creator of the project, SeedSigner "the person". That individual is additionally the only person in possession of the PGP keys that are used to sign the release images. -As of release 0.7.0 the images distributed via GitHub are reproducible. This means you and others can verify the released images are byte for byte the same when built from source. If you have the ability to read and understand source code; then you can contribute to this project by building from source and sharing the hash of the final images. +Starting with v0.7.0, the images distributed via GitHub are reproducible. This means you and others can verify the released images are byte-for-byte the same when built from source. You can contribute to this project by building from source and sharing the hash of the final images. Instructions to build a SeedSigner OS image (using precisely the same process that is used to create the prepared release images) have been made available. We have put a lot of thought and work into making these instructions easy to understand and follow, even for less technical users. These instructions can be found [here](https://github.com/SeedSigner/seedsigner-os/blob/main/docs/building.md). @@ -329,8 +329,8 @@ Letter templates(8.5in * 11in): * [29x29 - stores 24-word seeds ONLY as plaintext SeedQR format ONLY](docs/seed_qr/printable_templates/29x29_letter_trading_card_2sided.pdf) --------------- -# Developer Build Instructions -Raspberry Pi OS is commonly used for development. See the [Raspberry Pi OS Build Instructions](docs/raspberry_pi_os_build_instructions.md) - # Build from Source See the [SeedSigner OS repo](https://github.com/SeedSigner/seedsigner-os/) for instructions. + +# Developer Local Build Instructions +Raspberry Pi OS is commonly used for development. See the [Raspberry Pi OS Build Instructions](docs/raspberry_pi_os_build_instructions.md) From 8cbcfb0c77e40ac6937d88d560ef3998d5fffe9e Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Fri, 12 Apr 2024 09:01:51 -0400 Subject: [PATCH 6/7] Update README.md correct developer local build instructions link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54958c762..9346ea12c 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ * [Enclosure Designs](#enclosure-designs) * [SeedQR Printable Templates](#seedqr-printable-templates) * [Build from Source](#build-from-source) -* [Developer Local Build Instructions](#developer-build-instructions) +* [Developer Local Build Instructions](#developer-local-build-instructions) --------------- From 1ff9ac0302cd0b2d535da8d6b04d50d32774b04b Mon Sep 17 00:00:00 2001 From: Nick Klockenga Date: Fri, 12 Apr 2024 09:04:45 -0400 Subject: [PATCH 7/7] Update raspberry_pi_os_build_instructions.md minor edits from Keith --- docs/raspberry_pi_os_build_instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/raspberry_pi_os_build_instructions.md b/docs/raspberry_pi_os_build_instructions.md index 59b3ee534..01c1d2550 100644 --- a/docs/raspberry_pi_os_build_instructions.md +++ b/docs/raspberry_pi_os_build_instructions.md @@ -1,6 +1,6 @@ -# Raspberry Pi OS Build Instructions +# Raspberry Pi OS Local Dev Build Instructions -The released version of [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) does not use Raspberry Pi OS since version 0.6.0. These build instructions (previously referred to as "Manual Installation Instructions") are most commonly used by project contributors looking to do rapid development cycles. If this is what you'd like to do, then continue reading. +Since v0.6.0, official releases use our custom [SeedSigner OS](https://github.com/SeedSigner/seedsigner-os/) However, project contributors looking to do rapid development cycles typically use the older Raspberry Pi OS that we had previously built on prior to v0.6.0. If you're here to set up your SeedSigner for local development, continue reading. Begin by acquiring the latest 32-bit, Buster-based Raspberry Pi Lite operating system. This guide was tested using the version dated 2023-05-03; which can be found here: