zsh-users/zsh-syntax-highlighting

Should be noted in the documentation about sourcing when using brew

Open

#613 opened on May 13, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Shell (1,371 forks)batch import
TaskUpstreamcomponent:docsgood first issueresolution:if-and-when-needed

Repository metrics

Stars
 (22,617 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When you use homebrew there is a specific source path you need to use in .zshrc in order for it to work. This is non-obvious and can be easily missed in the homebrew printout after the install. This should be noted to make the install documentation better

Contributor guide

Research direction
Check the Homebrew installation output for the path to source the script, then document the required line for .zshrc.
Tech stack
shell
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitHomebrewbasic shell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80