vim-settings/README.md

28 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

## About
These are my Vim settings that I like to keep synced between my computers for convenience. This bootstrap setup will support both Vim and Neovim and uses different plugins, where needed, to bridge gaps in functionality. I use Neovim day to day, but there are times it is not available, so I maintain Vim support as well.
2012-03-29 03:18:33 +00:00
The bootstrap script included will set the proper symblinks and run vim-plug to install any plugins.
# Install
2016-05-03 18:56:09 +00:00
git clone https://github.com/ViViDboarder/vim-settings.git
cd vim-settings
2016-05-03 18:58:11 +00:00
make install
You can also remove any installed plugins or completely uninstall this configuration using either `make clean` or `make uninstall` respectively.
# Project Layout
2016-05-03 18:56:09 +00:00
The `vim` directory here is what gets symb linked to `~/.vim`, `~/.nvim`, and `~/.config/nvim`. Inside, the `init.vim` file will also get symblinked to `~/.vimrc` and `~/.nvimrc`. The other included directories are mostly standard vim directories that provide some additional configuration files. The exceptions would be `backup`, which becomes the new default location for storing backup files while editing. The `tmp` directory is for storing session information. The `rc` directory is where all the `vimrc` work gets done.
2016-05-03 18:56:09 +00:00
# The rc Files
2016-05-03 18:56:09 +00:00
The `init.vim` file essentially sets vim up to import the rc files from the `rc` directory. The actual configuration exists almost entirely in the `rc` directory. Each file should be fairly self explanatory.
2016-05-03 18:56:09 +00:00
One problem with syncing rc file between different machines, is that you may have different usages. That is solved by this framework by making use of `local.rc` files. For every `*.rc.vim`, you may provide a `*.local.rc.vim` file which will be loaded after the shared one. Here you can override or add anything to the synced configuration without it causing problems on any other machine.
2016-05-03 18:56:09 +00:00
## Note
2016-05-03 18:56:09 +00:00
I am not the original creators of some of the files included in the vim directory and only re-host them out of convienince. If I am missing any licensing information I'd be happy to attach it.