diff options
| author | Mitch Riedstra <Mitch@riedstra.us> | 2016-02-25 09:10:57 -0500 |
|---|---|---|
| committer | Mitch Riedstra <Mitch@riedstra.us> | 2016-02-25 09:10:57 -0500 |
| commit | 7609154c4d231b4983d6716056391e3b9a543b7e (patch) | |
| tree | 5746de6e67fb6f994ce61c6f00b5fcdb22e406ab /README.md | |
| parent | 2e885acd2773579a379750d6c7ad046bea8ba314 (diff) | |
| download | vim-cfg-7609154c4d231b4983d6716056391e3b9a543b7e.tar.gz vim-cfg-7609154c4d231b4983d6716056391e3b9a543b7e.tar.xz | |
Added some documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
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. + |