Repository navigation
docs: make the README work for someone arriving at the repo - #3
Merged
Merged
Conversation
It was written for someone who already had the working copy: no clone step, no toolchain requirement, no licence, no contributing section, and nothing saying the workflow is worktree-and-PR rather than commit-to-main. Also states that the build is ad-hoc signed and meant to be built locally, rather than letting someone find that out through a quarantine dialog.
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.
Problem
The README was written for someone who already had the working copy. On a public
repo it is the front door, and it had no clone step, no toolchain requirement, no
licence, no contributing section, and nothing telling a newcomer that the
workflow is worktree-and-PR rather than commit-to-main.
Approach
git cloneand states the requirement — macOS 13+ andthe Command Line Tools, no Xcode project to open.
locally, rather than letting someone discover that through a quarantine
dialog.
scripts/setup,scripts/task checkandscripts/agent start, and at therender-framesskill for anything visual.Look at this sceptically
mainfinishes. Itpoints at the workflow file, which is correct, but the first render may look
broken for a minute.
earns its place — the algorithm is the point of the project — but it is the
first thing to move into a
docs/page if this grows.