install.sh: Really copy files or setup existing ~/.axzsh directory

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index 95664a9c7d6eaa2a59bf37cbddd17f3085e63860..8375e58a7c68bb56703c5d846b6bc918edb4ec54 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,49 +5,28 @@ AX-ZSH is a modular configuration system for the Z shell. If provides sane
 defaults and is extendable by plugins.
 
 
-Configuration
--------------
-
-AX-ZSH can be configured using settings in a `$HOME/.zshenv` file.
+Installation
+------------
 
-The following configuration variables are supported:
+To install AX-ZSH, call the `install.sh` script inside of the source directory.
+This script creates the `~/.axzsh` symbolic link to the source directory and
+creates links for `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, and `~/.zlogout`
+(don't worry, already existing files are backed up).
 
-* `AXZSH_PLUGIN_D`: Optional directory for additional plugins.
-* `axzsh_default_plugins`: Array of default plugins, that will be loaded in
-  addition to the core plugins. You can reset this array to disable(!) loading
-  of these default plugins. Currently these plugins are loaded by default:
-   * byebye
-   * completion
-   * correction
-   * history
-   * ls
-   * prompt
-   * ssh
-   * std_aliases
-   * std_env
-* `axzsh_plugins`: Optional array of addiutional (non-core and non-default)
-  plugins to load.
+Then you have to restart your ZSH session.
 
-Example for a `$HOME/.zshenv` file:
 
-```
-# Add additinal custom plugin search path
-export AXZSH_PLUGIN_D="/opt/ax-zsh-plugins"
-
-# Disable all default plugins
-typedef -U axzsh_default_plugins
-axzsh_default_plugins=()
+Configuration
+-------------
 
-# Add additional plugins
-typedef -U axzsh_plugins
-axzsh_plugins=(
-       editor_select
-       homebrew
-)
-```
+Plugins are loaded when they are linked into the `$AXZSH/active_plugins/`
+directory.
 
-Note: it should *not* be necessary to disable the default plugins! The above
-is an example only!
+AX-ZSH doesn't use `~/.zshenv` in any way. So you can use this file for your
+own purposes (for example, to set up some environment variables that AX-ZSH
+relays on). In addition, AX-ZSH reads the optional files `~/.zprofile.local`,
+`~/.zshrc.local`, `~/.zlogin.local`, and `~/.zlogout.local` after its own
+core initialization files when present.
 
 
 Environment Variables