aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 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.
+