Added some documentation

3 files changed, 32 insertions, 73 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e78c6c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# vim-cfg
+
+
+Personal Vimrc + other addons
+
+No doubt there are likely other ways of keeping your vim configuration and
+all addons in source control, either way this is what I'm using.
+
+# How to use this:
+
+Run the following commands, be sure to _understand_ them first.
+
+``` bash
+cd $HOME
+git clone https://git.riedstra.us/mitch/vim-cfg
+cd $HOME/.vim
+./setup.sh
+./link-vimrc.sh
+```
+
+
+Once those commands complete you'll have installed my configuration.
+
+
+# Using this for yourself.
+
+It's pretty simple, if you add repositories anywhere in `$HOME/.vim` then
+just run `./gen-setup.sh` and it'll take care of making a new `./setup.sh`
+for you. Commit this and push it wherever.
+
diff --git a/link-vimrc.sh b/link-vimrc.sh
index 45e7e28..a4de866 100755
--- a/link-vimrc.sh
+++ b/link-vimrc.sh
@@ -24,7 +24,7 @@ for _file in $files; do
 		printf "REMOVE: \033[1;31m%s\033[0m\n" "$_file"
 	else
 		printf "\033[1;33mCREATED: %s\033[0m\n" "$_file"
-		ln -s .vim/init.vim $_file
+		ln -s $HOME/.vim/init.vim $_file
 	fi
 done
 
@@ -35,7 +35,7 @@ for _dir in $directories; do
 		printf "REMOVE: \033[1;31m%s\033[0m\n" "$_dir"
 	else
 		printf "\033[1;33mCREATED: %s\033[0m\n" "$_dir"
-		ln -s .vim $_dir
+		ln -s $HOME/.vim $_dir
 	fi
 done
 
diff --git a/setup-script.sh b/setup-script.sh
deleted file mode 100644
index 7977a15..0000000
--- a/setup-script.sh
+++ /dev/null
@@ -1,71 +0,0 @@
-#!/bin/sh
-
-WD="$(pwd)"
-
-clone() {
-	if [ -d "$DIR" ] ; then
-		cd $DIR
-		git pull --ff-only origin master
-	elif ! [ -d "$DIR" ] ; then
-		mkdir -p "$DIR"
-		cd "$DIR"
-		git clone "$URL" .
-	fi
-	cd $WD
-}
-
-DIR="bundle/emmet-vim"
-URL="https://github.com/mattn/emmet-vim.git"
-clone
-DIR="bundle/vim-airline"
-URL="https://github.com/vim-airline/vim-airline.git"
-clone
-DIR="bundle/ctrlp.vim"
-URL="https://github.com/kien/ctrlp.vim.git"
-clone
-DIR="bundle/gundo.vim"
-URL="https://github.com/sjl/gundo.vim.git"
-clone
-DIR="bundle/tagbar"
-URL="git://github.com/majutsushi/tagbar"
-clone
-DIR="bundle/ag.vim"
-URL="https://github.com/rking/ag.vim.git"
-clone
-DIR="bundle/vim-distinguished"
-URL="https://github.com/Lokaltog/vim-distinguished.git"
-clone
-DIR="bundle/vim-go"
-URL="https://github.com/fatih/vim-go.git"
-clone
-DIR="bundle/php.vim"
-URL="https://github.com/StanAngeloff/php.vim.git"
-clone
-DIR="bundle/nginx-vim-syntax"
-URL="https://git.riedstra.us/mitch/nginx-vim-syntax.git"
-clone
-DIR="bundle/vim-autocomplpop"
-URL="https://git.riedstra.us/mitch/vim-autocomplpop.git"
-clone
-DIR="bundle/vim-l9"
-URL="https://git.riedstra.us/mitch/vim-l9.git"
-clone
-DIR="bundle/nerdtree"
-URL="https://github.com/scrooloose/nerdtree.git"
-clone
-DIR="themes/vim-256noir"
-URL="https://git.riedstra.us/mitch/vim-256noir.git"
-clone
-DIR="themes/vim-colors-penultimate"
-URL="https://github.com/ivan-cukic/vim-colors-penultimate"
-clone
-DIR="themes/alduin"
-URL="https://git.riedstra.us/mitch/Alduin.git"
-clone
-DIR="themes/oceanic-next"
-URL="https://github.com/mhartington/oceanic-next"
-clone
-# DIR="."
-# URL="git@git.riedstra.us:mitch/vim-cfg.git"
-# clone
-