X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=3ddbd0cb9287f4bae4d42f278a3b7e5943c8a11c;hb=d9321031384d5202023772a03225bd7df01f3490;hp=27ac06ae71992a98bbc10566c6a766f5198f8bd4;hpb=5feaf121801fca0373660e54e8af08a3c75a5f8a;p=ax-zsh.git diff --git a/README.md b/README.md index 27ac06a..3ddbd0c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ AX-ZSH: Alex' Modular ZSH Configuration AX-ZSH is a modular configuration system for the Z shell (ZSH). It provides sane defaults and is extendable by plugins. - Installation ------------ @@ -15,13 +14,13 @@ up the `~/.axzsh` directory. When using Git it is best to directly clone the AX-ZSH repository into the `~/.axzsh` directory and call `install.sh` from this location. -Clone repository from _GitHub_ (https://github.com/alexbarton/ax-zsh): +Clone repository from _GitHub_ (): - $ git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh + git clone https://github.com/alexbarton/ax-zsh.git ~/.axzsh Then run the installer script: - $ ~/.axzsh/install.sh + ~/.axzsh/install.sh The `install.sh` script creates symbolic links for `~/.zprofile`, `~/.zshrc`, `~/.zlogin`, and `~/.zlogout` (don't worry, already existing files are backed @@ -31,7 +30,6 @@ Now close and restart all your running ZSH session to activate AX-ZSH. To update AX-ZSH run `axzshctl upgrade`. - AX-ZSH & Local ZSH Configuration -------------------------------- @@ -45,13 +43,12 @@ You can use the following files for local ZSH configuration: 1. 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). + relies on). 2. AX-ZSH reads the optional files `~/.zprofile.local`, `~/.zshrc.local`, `~/.zlogin.local`, and `~/.zlogout.local` after its own core initialization files when present. - Customization ------------- @@ -68,7 +65,6 @@ by default. In addition you can set the `AXZSH_PLUGIN_D` variable (and `ZSH_CUSTOM` like "OhMyZsh") to specify additional plugin search directories. - Environment Variables --------------------- @@ -86,5 +82,6 @@ Validated and/or set up by core plugins: * `PS1` * `SHORT_HOST` * `TERM` +* `XDG_RUNTIME_DIR` * `XDG_CACHE_HOME` * `ZSH_CACHE_DIR`