Merge branch 'ELLIOTTCABLE-refactors'

Fixed minor conflicts in zgen.zsh
kevcrumb · Mar 8, 2016 · ca19ec2 · ca19ec2
2 parents 740efb8 + f4658f7
commit ca19ec2
Show file tree

Hide file tree

Showing 2 changed files with 142 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -82,6 +82,11 @@ Returns 0 if an init script exists.
 You can set the environment variable ZGEN_RESET_ON_CHANGE. These files will be checked and if a change is detected zgen reset is called.
  ZGEN_RESET_ON_CHANGE=(${HOME}/.zshrc ${HOME}/.zshrc.local)
 
+### Notes
+Be aware that `zgen` tries to handle [`compinit`][compinit] for you to allow for the fastest possible initialization times. However, this functionality will be disabled if you've already called `compinit` yourself before sourcing `zgen.zsh`. (Alternatively, you can disable it yourself by disabling `$ZGEN_AUTOLOAD_COMPINIT`.)
+
+ [compinit]: <http:https://zsh.sourceforge.net/Doc/Release/Completion-System.html#Use-of-compinit> "Zsh manual 20.2.1: Use of compinit"
+
 ### Example .zshrc
 
 ```zsh