6fe78e06291bdf6fc62b805b0171e16a6b71eee1

Author
Marc Cornellà <marc@mcornella.com>
Committer
Marc Cornellà <marc@mcornella.com>
Date

Message

chore: better document top-level custom files for aliases (#12504)

See discussion in https://github.com/ohmyzsh/ohmyzsh/discussions/12504

Diff

 1diff --git a/templates/zshrc.zsh-template b/templates/zshrc.zsh-template
 2index a73d6079923429d0a642ab0faa26c448932c9e25..89fd0780e0982335a4bf7956a09c48321a4cc9dd 100644
 3--- a/templates/zshrc.zsh-template
 4+++ b/templates/zshrc.zsh-template
 5@@ -1,11 +1,11 @@
 6 # If you come from bash you might have to change your $PATH.
 7 # export PATH=$HOME/bin:$HOME/.local/bin:/usr/local/bin:$PATH
 8 
 9-# Path to your oh-my-zsh installation.
10+# Path to your Oh My Zsh installation.
11 export ZSH=$HOME/.oh-my-zsh
12 
13 # Set name of the theme to load --- if set to "random", it will
14-# load a random theme each time oh-my-zsh is loaded, in which case,
15+# load a random theme each time Oh My Zsh is loaded, in which case,
16 # to know which specific one was loaded, run: echo $RANDOM_THEME
17 # See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
18 ZSH_THEME="robbyrussell"
19@@ -91,9 +91,12 @@ source $ZSH/oh-my-zsh.sh
20 # Compilation flags
21 # export ARCHFLAGS="-arch x86_64"
22 
23-# Set personal aliases, overriding those provided by oh-my-zsh libs,
24-# plugins, and themes. Aliases can be placed here, though oh-my-zsh
25-# users are encouraged to define aliases within the ZSH_CUSTOM folder.
26+# Set personal aliases, overriding those provided by Oh My Zsh libs,
27+# plugins, and themes. Aliases can be placed here, though Oh My Zsh
28+# users are encouraged to define aliases within a top-level file in
29+# the $ZSH_CUSTOM folder, with .zsh extension. Examples:
30+# - $ZSH_CUSTOM/aliases.zsh
31+# - $ZSH_CUSTOM/macos.zsh
32 # For a full list of active aliases, run `alias`.
33 #
34 # Example aliases