From 6cc600335a7d74d7a3cc789287013745a981a125 Mon Sep 17 00:00:00 2001 From: "Mario P. Cardenas" <15961362+Mario-paul@users.noreply.github.com> Date: Sun, 22 Aug 2021 13:15:38 -0400 Subject: [PATCH] docs: final candidate draft for sourcing on package installs - INSTALL.md --- INSTALL.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 0d3ec67..b12352b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -34,13 +34,30 @@ First, install the package: See also [repology's cross-distro index](https://repology.org/metapackage/zsh-syntax-highlighting/versions) -Second, enable zsh-syntax-highlighting by adding the following line to the end of your .zshrc, +Second, enable zsh-syntax-highlighting by sourcing the script. Running this command on the terminal will add the source line to the end of your .zshrc: -* On most Linux distributions (except perhaps NixOS): `source /usr/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh` -* Mac OS X / Homebrew: `somewhere under /opt under Homebrew (please confirm)` -* NetBSD and OpenBSD: `source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh` +* On most Linux distributions (except perhaps NixOS): - Then restart zsh (such as by opening a new instance of your terminal emulator). +```zsh + echo "source /usr/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ${ZDOTDIR:-$HOME}/.zshrc +``` + +* Mac OS X / Homebrew, NetBSD and OpenBSD: + +```zsh + echo "source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh" ${ZDOTDIR:-$HOME}/.zshrc +``` + +Then restart zsh (such as by opening a new instance of your terminal emulator). + + If your .zshrc file is somewhere other than `/home`, or if above the command fails, add the `source` command manually **at the end** of your `.zshrc`: + +* On most Linux distributions (except perhaps NixOS): +`source /usr/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh` +* Mac OS X / Homebrew, NetBSD and OpenBSD: +`source /usr/local/share/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh` + +Then restart zsh. ### In your ~/.zshrc