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

[ax-zsh.git] / README.md

diff --git a/README.md b/README.md
index 940fc19f8c3f6d45eb5f4678c18d62d17b525e89..8375e58a7c68bb56703c5d846b6bc918edb4ec54 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,33 @@
 AX-ZSH: Alex' Modular ZSH Configuration
 =======================================
 
+AX-ZSH is a modular configuration system for the Z shell. If provides sane
+defaults and is extendable by plugins.
+
+
+Installation
+------------
+
+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).
+
+Then you have to restart your ZSH session.
+
+
+Configuration
+-------------
+
+Plugins are loaded when they are linked into the `$AXZSH/active_plugins/`
+directory.
+
+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
 ---------------------
@@ -10,7 +37,7 @@ Expected to be already set:
 * `HOME`
 * `LOGNAME`
 
-Validated and/or set up:
+Validated and/or set up by core plugins:
 
 * `AXZSH`
 * `HOST`
@@ -21,12 +48,3 @@ Validated and/or set up:
 * `TERM`
 * `XDG_CACHE_HOME`
 * `ZSH_CACHE_DIR`
-
-
-Configuration Variables
------------------------
-
-The following configuration variables can be set in the `$HOME/.zshenv` file
-to configure "AX-ZSH":
-
-* `AXZSH_PLUGIN_D`