From f79021ad85816525aaf92ed71c584a01b2dcf433 Mon Sep 17 00:00:00 2001 From: Bert Peters Date: Tue, 7 Jun 2016 17:01:56 +0200 Subject: [PATCH] Update README Readme instructions now actually match the contents of the repository again. --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f00125e..4fa422e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -vimconfig -========= +# vimconfig -An attempt to normalize my Vim configuration across machines. +An attempt to normalize my Vim configuration across machines. Incidentally +contains packages that are not vim now, but it still synchronizes my +configuration. -Installation ------------- - -To install this package as your local vim configuration, do the following: +## Installation ```bash -git clone https://github.com/bertptrs/vimconfig.git ~/.vim -~/.vim/install.sh +git clone https://github.com/bertptrs/vimconfig.git +./vimconfig/install.sh ``` This will install the correct vimrc and load the packages mentioned in bundle. +There are some requirements: + +* `stow` must be available. +* `gsettings` must be available. This currently does not block installation, + but the installation will not be complete without it.