]> arthur.barton.de Git - ax-zsh.git/commitdiff
README.md: Add "installation" section
authorAlexander Barton <alex@barton.de>
Thu, 30 Jul 2015 14:20:05 +0000 (16:20 +0200)
committerAlexander Barton <alex@barton.de>
Thu, 30 Jul 2015 14:20:05 +0000 (16:20 +0200)
README.md

index 965733ddd88d017b3dcb924d09d719fe095f8308..948648d25ebb56bad3dc67c54ddbc89a69ed8f50 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,17 @@ 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
 -------------