README.md

   1 # A modular vim configuration
   2
   3 This is my personal vim configuration that is partly inspired by SpaceVim. It
   4 is compatible to neovim and (g)vim (version 8 or higher). The configuration is
   5 split up into multiple files such that personal customization is separated from
   6 boilerplate code.
   7
   8
   9 ## Installation
  10
  11 Simply clone this repository into ~/.vim and invoke install.sh therein. The
  12 install script just creates symlinks to vim/gvim/neovim configuration files and
  13 directories.
  14
  15 ````
  16 git clone https://git.sthu.org/repos/vimconf.git ~/.vim
  17 ~/.vim/install.sh
  18 ````
  19
  20 The install file also checks requirements for the configuration and the plugins
  21 added:
  22
  23   - python3 support for vim/gvim
  24   - neovim python3 module
  25   - aspell
  26
  27
  28 ## Specialization for local machines
  29
  30 I personally would like to have the same vim configuration on all my accounts.
  31 Still, on certain machines I would like to personalize and specialize the
  32 configuration. The following files are read if existent:
  33
  34   - plugins-local.vim
  35   - macros-local.vim
  36   - keymaps-local.vim
  37   - init-local.vim
  38
  39 For all four example files are shipped with the repository.