diff --git a/README.md b/README.md index 895a12e..d8a0860 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,32 @@ ## 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. +These are my Vim and Neovim 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. -The bootstrap script included will set the proper symblinks and run vim-plug to install any plugins. +I use Neovim day to day, but there are times it is not available, so Vim and older Neovim installs are supported as well. -# Install +Vim and Neovim less than 0.5 support is really in maintanence mode now and not heavily maintained. + +The bootstrap script included will set the proper symblinks and run package managers to install any plugins. + +## Install git clone https://github.com/ViViDboarder/vim-settings.git cd vim-settings make install -You can also remove any installed plugins or completely uninstall this configuration using either `make clean` or `make uninstall` respectively. +You can also remove any installed plugins or uninstall this configuration using either `make clean` or `make uninstall` respectively. -# Project Layout +## Project Layout -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. +The `vim` directory here is what gets symblinked to `~/.vim`, and the `neovim` directory gets symblinked to `~/.config/nvim`. Inside, the `init.vim` file will also get symblinked to `~/.vimrc`. The `neovim/init.vim` file will dyanmically load the older non-Lua configs if Lua is not supported. 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. -# The rc Files +## Neovim config + +This config is in Lua with the philosopy of taking advantage of as much out of the box capaiblities as possible. + +## Vim and old Nvim + +### The rc Files 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. @@ -24,4 +34,4 @@ One problem with syncing rc file between different machines, is that you may hav ## Note -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. +I am not the original creators of some of the files included in the vim directory and only vendor them out of convienince. If I am missing any licensing information I'd be happy to attach it.