aboutsummaryrefslogtreecommitdiff
path: root/system/zsh-syntax-highlighting/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/zsh-syntax-highlighting/README')
-rw-r--r--system/zsh-syntax-highlighting/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/system/zsh-syntax-highlighting/README b/system/zsh-syntax-highlighting/README
new file mode 100644
index 0000000000000..f5534846ff86b
--- /dev/null
+++ b/system/zsh-syntax-highlighting/README
@@ -0,0 +1,12 @@
+zsh-syntax-highlighting (Fish shell like syntax highlighting for Zsh)
+
+Provides syntax highlighing for the shell zsh. It enables highlighing
+of commands whilst they are typed at a zsh prompt into an interactive
+ terminal. This helps in reviewing commands before running them,
+particularly in catching syntax errors.
+
+Enable syntax highlighting in the current interactive shell:
+
+ source /usr/share/zsh/plugins/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh
+
+NOTE: the 'source' command must be **at the end** of '~/.zshrc'.