diff options
author | Lawrence Shah <lawrenceshah@users.noreply.github.com> | 2023-06-05 01:20:32 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-05 10:20:32 +0200 |
commit | 62ab5406dd89848bb26e8c6e648eb7d860e9dce5 (patch) | |
tree | a66c8be3e31d4cb5a3ce921f6f69223795ce5ee6 /custom | |
parent | 6101106916147b1716ff2d5de4a53260e7607bae (diff) | |
download | zsh-62ab5406dd89848bb26e8c6e648eb7d860e9dce5.tar.gz zsh-62ab5406dd89848bb26e8c6e648eb7d860e9dce5.tar.bz2 zsh-62ab5406dd89848bb26e8c6e648eb7d860e9dce5.zip |
docs(custom): update comments in example files (#11727)
Diffstat (limited to 'custom')
-rw-r--r-- | custom/example.zsh | 18 | ||||
-rw-r--r-- | custom/plugins/example/example.plugin.zsh | 1 | ||||
-rw-r--r-- | custom/themes/example.zsh-theme | 2 |
3 files changed, 13 insertions, 8 deletions
diff --git a/custom/example.zsh b/custom/example.zsh index c505a9673..21a8d8be7 100644 --- a/custom/example.zsh +++ b/custom/example.zsh @@ -1,10 +1,12 @@ -# You can put files here to add functionality separated per file, which -# will be ignored by git. -# Files on the custom/ directory will be automatically loaded by the init -# script, in alphabetical order. - -# For example: add yourself some shortcuts to projects you often work on. -# +# Put files in this folder to add your own custom functionality. +# See: https://github.com/ohmyzsh/ohmyzsh/wiki/Customization +# +# Files in the custom/ directory will be: +# - loaded automatically by the init script, in alphabetical order +# - loaded last, after all built-ins in the lib/ directory, to override them +# - ignored by git by default +# +# Example: add custom/shortcuts.zsh for shortcuts to your local projects +# # brainstormr=~/Projects/development/planetargon/brainstormr # cd $brainstormr -# diff --git a/custom/plugins/example/example.plugin.zsh b/custom/plugins/example/example.plugin.zsh index 406f27445..83611fe3f 100644 --- a/custom/plugins/example/example.plugin.zsh +++ b/custom/plugins/example/example.plugin.zsh @@ -1,2 +1,3 @@ # Add your own custom plugins in the custom/plugins directory. Plugins placed # here will override ones with the same name in the main plugins directory. +# See: https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-plugins diff --git a/custom/themes/example.zsh-theme b/custom/themes/example.zsh-theme index ef8f1c630..494d029e8 100644 --- a/custom/themes/example.zsh-theme +++ b/custom/themes/example.zsh-theme @@ -1,4 +1,6 @@ # Put your custom themes in this folder. +# See: https://github.com/ohmyzsh/ohmyzsh/wiki/Customization#overriding-and-adding-themes +# # Example: PROMPT="%{$fg[red]%}%n%{$reset_color%}@%{$fg[blue]%}%m %{$fg[yellow]%}%~ %{$reset_color%}%% " |