From 0402a8b20b16784cf1ea71f6e163becc0f4ebc01 Mon Sep 17 00:00:00 2001 From: Alexander Rosenberg Date: Wed, 3 May 2023 16:29:35 -0700 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6ffc4eb..9ab9f23 100644 --- a/README.md +++ b/README.md @@ -21,5 +21,16 @@ ZSH_CONFIG_DIR="path/to/this/repo" # This variable *MUST* be set source "${ZSH_CONFIG_DIR}/init.zsh" ``` 3. Optionally, set some other variables (before the `source` line): - * ZSH_BOOKMARK_DIR: Bookmark directory (default: ~/.cache/zsh/bookmarks) - * ZSH_BOOKMARK_LS: If true, run `ls` after jumping to a bookmark + * ZSH_BOOKMARK_DIR: Bookmark directory (default: ~/.cache/zsh/bookmarks) + * ZSH_BOOKMARK_LS: If true, run `ls` after jumping to a bookmark (default: + true) + * ZSH_USER_DIR: Directory containing configuration files (see below, default: + ~/.zsh.d) + +### Configuration +To configure, create `~/.zsh.d` (or set ZSH_USER_DIR as described above). The +create either of the option files `init.zsh` and `early-init.zsh`. The former is +run in the middle of startup, after most plugins have been initialized, but +before ones related to command history, auto-complete, etc. The latter is run as +the first thing in the configuration file (after `autoload -U compinit && +compinit`).