]> arthur.barton.de Git - OhMyZshExtensions.git/commitdiff
Add initial README.md file
authorAlexander Barton <alex@barton.de>
Mon, 25 May 2015 00:05:48 +0000 (02:05 +0200)
committerAlexander Barton <alex@barton.de>
Mon, 25 May 2015 00:05:48 +0000 (02:05 +0200)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..82b0202
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Alex' "Oh My ZSH" Extensions
+
+
+## Prerequisites
+
+1. You must be using ZSH and
+2. ["OhMyZsh"](https://github.com/robbyrussell/oh-my-zsh) must be installed
+   and set up properly.
+
+
+## Installation
+
+1. Download and copy the "OhMyZshExtensions" directory anywhere to the local
+   system, or even better, clone the project using Git.
+2. Set up the `ZSH_CUSTOM` variable in your `$HOME/.zshrc` file to correctly
+   point to the "OhMyZshExtensions" directory.
+3. Add the desired plugins the the `plugins` array in your `$HOME/.zshrc` file.