fixed install.sh

[dotfiles.git] / README

diff --git a/README b/README
index 8f290e0..51a0434 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,13 @@
-Dotfile for my work machine.
+Dotfiles
 
-Crontab can be installed to auto update the address book for all employees.
+Run install.sh to load the dotfiles, the script assumes them being linked and
+replaces the link with a link to this directory.
 
-Programs needed that are not installed by default:
-- mutt
-- notmuch
-- i3wm
+To load the vim plugins you have to clone the repo recursively:
+       git clone --recursive https://github.com/dopefishh/dotfiles.git
+
+If you forgot the recursive flag you can do:
+       git submodule init
+       git submodule update
+       git submodule foreach git submodule init
+       git submodule foreach git submodule update