README.md

   1 AX-ZSH: Alex' Modular ZSH Configuration
   2 =======================================
   3
   4 AX-ZSH is a modular configuration system for the Z shell. If provides sane
   5 defaults and is extendable by plugins.
   6
   7
   8 Installation
   9 ------------
  10
  11 To install AX-ZSH, call the `install.sh` script inside of the source directory.
  12 This script creates the `~/.axzsh` symbolic link to the source directory and
  13 creates links for `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, and `~/.zlogout`
  14 (don't worry, already existing files are backed up).
  15
  16 Then you have to restart your ZSH session.
  17
  18
  19 Configuration
  20 -------------
  21
  22 Plugins are loaded when they are linked into the `$AXZSH/active_plugins/`
  23 directory.
  24
  25 AX-ZSH doesn't use `~/.zshenv` in any way. So you can use this file for your
  26 own purposes (for example, to set up some environment variables that AX-ZSH
  27 relays on). In addition, AX-ZSH reads the optional files `~/.zprofile.local`,
  28 `~/.zshrc.local`, `~/.zlogin.local`, and `~/.zlogout.local` after its own
  29 core initialization files when present.
  30
  31
  32 Environment Variables
  33 ---------------------
  34
  35 Expected to be already set:
  36
  37 * `HOME`
  38 * `LOGNAME`
  39
  40 Validated and/or set up by core plugins:
  41
  42 * `AXZSH`
  43 * `HOST`
  44 * `HOSTNAME` (same as HOST, deprecated)
  45 * `LOCAL_HOME`
  46 * `PS1`
  47 * `SHORT_HOST`
  48 * `TERM`
  49 * `XDG_CACHE_HOME`
  50 * `ZSH_CACHE_DIR`