Browse Source

docs(custom): update comments in example files (#11727)

Lawrence Shah 11 months ago
parent
commit
62ab5406dd
3 changed files with 13 additions and 8 deletions
  1. 10 8
      custom/example.zsh
  2. 1 0
      custom/plugins/example/example.plugin.zsh
  3. 2 0
      custom/themes/example.zsh-theme

+ 10 - 8
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
-#

+ 1 - 0
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

+ 2 - 0
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%}%% "