Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme file - Update file verification section (to use keybase.io), clarify the download section, and other minor edits #285

Merged
merged 30 commits into from
Feb 27, 2023
Merged

Readme file - Update file verification section (to use keybase.io), clarify the download section, and other minor edits #285

Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
fa64a98
Update ReadmeFile - with initial small changes
Marc-Gee Dec 7, 2022
86a5d1f
A Heading change
Marc-Gee Dec 7, 2022
5a1bb41
minor spelling fixes
Marc-Gee Dec 7, 2022
4f910cf
Rewrite the software Download, & Verify sections
Marc-Gee Dec 7, 2022
69dc06c
Minor edits to download and veryify sections.
Marc-Gee Dec 7, 2022
1175ec4
Various Minor Language edits
Marc-Gee Dec 10, 2022
d57ea8c
Add sample images to PubKey verification section
Marc-Gee Dec 11, 2022
85fae7b
Formatting changes and updated verify Screenshots
Marc-Gee Dec 11, 2022
47fb9fe
Edits to the shasum command description
Marc-Gee Dec 12, 2022
b9649cb
Minor Edits
Marc-Gee Dec 12, 2022
76875f6
Minor edits and clarifications.
Marc-Gee Dec 12, 2022
d2a657f
Various edits B4 upstream submission
Marc-Gee Dec 12, 2022
923ce08
Various edits B4 Upstream commit
Marc-Gee Dec 12, 2022
fa8573c
Merge pull request #6 from Marc-Gee/dev
mauriciozuardi Dec 14, 2022
2318372
Update README.md
Marc-Gee Jan 9, 2023
3c43ea3
Updates to shorten the verification instructions
Marc-Gee Jan 29, 2023
7216a8d
Insert smaller (80pct sized) screenshots
Marc-Gee Jan 29, 2023
6154607
Improved Screenshots
Marc-Gee Jan 29, 2023
b04383d
Verification: Shortening, reordering & clarify
Marc-Gee Jan 29, 2023
a136a86
Fix Spelling, grammar and shasum command
Marc-Gee Jan 30, 2023
e1090ba
Fix SHASUM option flag typo --check
Marc-Gee Jan 31, 2023
d8de405
Inserted instructions on MicroSD writing.
Marc-Gee Feb 3, 2023
8575e4d
Micro SD Instructions
Marc-Gee Feb 16, 2023
50cf8dd
Inserted a table format for the different binaries
Marc-Gee Feb 17, 2023
081d24f
updated download table layout to 2 columns
Marc-Gee Feb 25, 2023
594751b
changes to file names in scripts/commands
Marc-Gee Feb 25, 2023
e225e05
Fixed TitleCase issues throughout document
Marc-Gee Feb 25, 2023
ac8ba47
Instructions added if: wifi component was physically removed
Marc-Gee Feb 25, 2023
6d535e9
Titlecase corrections to prior commit
Marc-Gee Feb 27, 2023
4fae69e
reorder download table and add tooltips
Marc-Gee Feb 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,22 +86,21 @@ However, one of the many advantages of the open source software model is that th


Download the current Version (0.6.0) software image that is compatible with your Raspberry Pi Hardware:
| Raspberry Pi Hardware | Source |
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
| Pi Zero v1.3 or Pi Zero (W or WH) | [SeedSigner for R-Pi Zero V1.3](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi0.img) |
| Pi Zero **2** W | [SeedSigner for R-Pi Zero 2 W](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi02w.img) |
| Pi 2 (not a Pi *Zero* 2) | [SeedSigner for R-Pi 2](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi2.img) |
| Pi 3 | [SeedSigner for R-Pi 3](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi02w.img) |
| Pi 4 | [SeedSigner for R-Pi 4](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi04.img) |

**and also download** these 2 signature verification files
[Plaintext Manifest File](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/seedsigner_0_6_0.img.sha256)
[Signed Mainifest File](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/seedsigner_0_6_0.img.sha256.sig)

**Note:** The version numbers of the latest files will be higher than this example, but the naming format will be the same.
| The small-sized Raspberry Pi Hardware models (the ZERO's) | | The large-sized Raspberry Pi Hardware models (Full size) |
|--- |--- |--- |
| [SeedSigner software for the Pi Zero **2** W (The "Pi Zero **TWO** W")](https://github.com/seedsigner/seedsigner/releases/download/0.6.0/seedsigner_os.0.6.0.pi02w.img) | | [SeedSigner software for the Raspberry Pi 4 Model B](https://github.com/seedsigner/seedsigner/releases/download/0.6.0/seedsigner_os.0.6.0.pi4.img) |
| [SeedSigner software for the Pi Zero W or Pi Zero WH](https://github.com/seedsigner/seedsigner/releases/download/0.6.0/seedsigner_os.0.6.0.pi0.img) | | [SeedSigner software for the Raspberry Pi 3 Model B](https://github.com/seedsigner/seedsigner/releases/download/0.6.0/seedsigner_os.0.6.0.pi02w.img) |
| [SeedSigner software for the Pi Zero **V1.3**](https://github.com/seedsigner/seedsigner/releases/download/0.6.0/seedsigner_os.0.6.0.pi0.img) | | [SeedSigner software for the Raspberry Pi 2 Model B ](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/SeedSigner_OS.0.6.0.pi2.img) <br> This is not the file for a Pi **ZERO** 2. <br>That hardware is a different chipset and motherboard. |
Copy link

Choose a reason for hiding this comment

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

In the basename of the url for RPi2 download...

"SeedSigner_OS.0.6.0.pi2.img" works but might be more case-specifically-correct as "seedsigner_os.0.6.0.pi2.img"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thx. corrected to lowercase. I also made a few other case corrections via a search and replace, so now:
all URL's are lowercase.
link descriptions are TitleCase: "SeedSinger".
The project name is TitleCase: SeedSinger (but not in any urls).
YouTube URL's do use capitalization (reasons vary but for link shortening afaik) so those have been left as-is.


**also download** these 2 signature verification files to the same folder
[The Plaintext Manifest File](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/seedsigner.0.6.0.sha256)
[The Signed Manifest File](https://github.com/SeedSigner/seedsigner/releases/download/0.6.0/seedsigner.0.6.0.sha256.sig)
Copy link

Choose a reason for hiding this comment

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

"The Signed Manifest File" becomes "The Signature of the manifest file"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


Users of our software prior to version 0.6.0 might be surprised how fast their downloads are, but since the our migration to SeedSignerOS the software files are in fact, 100x smaller and hence your downloads and verifications will be very quick now! (approx 40 Megabyte images)
Copy link

Choose a reason for hiding this comment

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

"..., but since the our migration..." becomes "..., but since our migration..."


Once the files have all finished downloading, follow the steps below to verify the download before continuing on to write the software onto a MicroSD card. Next, insert the MicroSD into your assembled hardware and connect the USB power. Allow about 45 seconds for our logo to appear, and then you can begin using your Seedsigner!

Previous software versions are available [here](https://github.com/SeedSigner/seedsigner/releases). Choose a specific version and the expand the *Assets* sub-heading to download the .img file binary and also the 2 associated signature files .
[Previous software versions are available here](https://github.com/SeedSigner/seedsigner/releases). Choose a specific version and then expand the *Assets* sub-heading to display the .img file binary and also the 2 associated signature files. **Note:** The prior version files will have lower numbers than the scripts and examples provided in this document, but the naming format will be the same, so you can edit them as required for signature verification etc.


## Verifying that the downloaded files are authentic (optional but highly recommended!)
Expand Down