/pr-vimod

Primary LanguageVim Script

VIMod⚡

VIMod (VIM + Vemod) is my personal Vim 9.0+ configuration.

VIMod is designed to complement any existing Vim setup, but works equally well on a fresh install!
If you ever decide to remove VIMod, your Vim setup will return to its original state.

demo VIMod and the Quick UI, reachable by pressing Space.

Learn more about VIMod, and how to use it, on the Wiki.

Never used Vim before?
Read the new user guide to get started.

Install

  1. Copy VIMod to your Vim configuration directory.
    • Clone with Git if you want to easily update VIMod in the future.
  2. Add the runtime to the top of your vimrc file.

OS specific instructions:

Windows
  1. Clone the VIMod repository to your local machine.
    git clone https://github.com/hezkore/vimod.git %USERPROFILE%/vimfiles/vimod
  2. Add the runtime at the top of your vimrc file.
    runtime vimod/vimod.vim
Unix-based
  1. Clone the VIMod repository to your local machine:
    git clone https://github.com/hezkore/vimod.git ~/.vim/vimod
  2. Add the runtime at the top of your vimrc file:
    runtime vimod/vimod.vim

To get the full VIMod experience, make sure to enable the Extended Keymaps.

Read the Wiki for instructions on how to use VIMod.

Get a local copy of the wiki pages:

git clone https://github.com/Hezkore/vimod.wiki.git

Troubleshooting

If you are unsure where your vimrc file is located, run the following command in Vim: :echo $MYVIMRC

If you are unsure if the runtime was added correctly, look for the VIMod version number in the lower left corner when starting Vim.
If it doesn't say VIMod vX.X.X, the runtime was not added correctly.

VIMod will install and manage all plugins and dependencies automatically when you start Vim for the first time.
The install screen will automatically close when the installation is complete, so just sit tight and wait for it to finish.

Updating

VIMod

If Git was used to clone the VIMod repository, you can update VIMod by running the following command in the VIMod directory:

git pull

Otherwise you can download the latest source code and extract it to the VIMod directory.

Remember to always run :PlugInstall after an update as plugins may have been changed.

Plugins

To update all plugins, run the following command in Vim:

:PlugUpdate

Uninstall

To uninstall VIMod, remove the runtime from your vimrc file and delete the VIMod directory.