docs: the hardware specs no longer wait for you - #53
Merged
Conversation
They stopped for someone to pick the COM port. They find the board by USB vendor ID now and skip themselves when none is attached, so the sentence about having the hardware in front of you was the wrong way round: it is unattended, and the board being there is what decides. The testing section also grew the three platform rounds and `verify`, which is what a contributor runs before pushing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two things the readme still said after today.
The hardware specs pause for the COM port. They did until #51. They find the board by its USB vendor ID now and skip themselves when none is attached, so the run is unattended. CONTRIBUTING already says so; the readme did not.
The three platform rounds and
verifywere missing.yarn test:all:mac,:windowsand:linuxrun everything a platform can, ending with what only that platform has.verifyis the shorter one before pushing.The rest of the readme was checked against main and holds: the download line, the macOS floor, the Linux permissions section, and the dialout note.