Repository navigation
docs: reorder the README around what it is for - #40
Merged
Merged
Conversation
The old order asked the reader to earn the pitch. Three sections in,
before a single example of `gwt add`, came twenty-six lines on oh-my-zsh
alias conflicts and PATH ordering — a wall at the entrance. The one
thing no competing tool does, per-worktree colour, sat at line 372 of
466, four fifths of the way down and with no picture.
Reordered so that what earns attention comes first, what reassures comes
next, and what troubleshoots comes last:
- the pitch names the gap it fills, against `git worktree add` rather
than against another tool
- the screenshot sits under it, two windows and two colours
- commands, then configuration, then shell integration
- `gwt doctor` moves under Troubleshooting, where it belongs
- Development and Releasing move to the end under 'For maintainers':
a user of the package has no use for how it gets published
Usage keeps the warning the old order carried by accident: `gwt` needs
the shell integration, and without it oh-my-zsh answers instead. Six
lines and a link rather than a section.
The image is referenced by absolute URL. npmjs.com renders this README
too, and `files` does not ship docs/, so a relative path would render
broken there.
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
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.
The old order asked the reader to earn the pitch.
Three sections in, before a single example of
gwt add, came twenty-six lines on oh-my-zsh alias conflicts and PATH ordering — a wall at the entrance. And the one thing no competing tool does, per-worktree colour, sat at line 372 of 466 with no picture.New order
.envgwt doctor)The pitch
It positions against git own behaviour, not against another tool. Anyone who has run
git worktree addrecognises the disappointment; nobody gets free advertising.What was kept
Usagestill carries the warning the old order carried by accident:gwtneeds the shell integration, and without it oh-my-zsh answers instead. Six lines and a link rather than a section at the door.Every section survives — nothing dropped, only moved, with two renamed (
Worktree theming→How the colours work) and a newTroubleshootinggrouping.One detail
The screenshot is referenced by absolute URL. npmjs.com renders this README too, and
filesdoes not shipdocs/, so a relative path would render broken there.