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 vim, gvim (8.0+) and neovim (0.2+). The configuration is split
   5 up into multiple files such that personal customization is separated from
   6 boilerplate code.
   7
   8
   9 ## Installation
  10
  11 ### Requirements
  12
  13 The install script that is shipped with this configuration also checks
  14 for the following requirements:
  15
  16   - python3 support for vim/gvim
  17   - neovim python3 module
  18   - aspell
  19
  20 Under a Debian-like Linux system you can install these by the following commands
  21
  22 ````
  23 sudo apt-get install aspell aspell-de python3-pip
  24 pip3 install neovim
  25 ````
  26
  27 ### Clone & install
  28
  29 If you already have a vim configuration in place then you may first move your
  30 ~/.vim directory first
  31
  32 ````
  33 mv ~/.vim ~/.vim-old
  34 ````
  35
  36 Assumung that there is ~/.vim anymore, simply clone this repository into ~/.vim
  37 and invoke install.sh therein.
  38
  39 ````
  40 git clone https://git.sthu.org/repos/vimconf.git ~/.vim
  41 ~/.vim/install.sh
  42 ````
  43
  44 This install script creates backups of existing configuration files (e.g.,
  45 ~/.vimrc) and then creates symlinks to configuration files in ~/.vim.
  46
  47
  48 ## Specialization for local machines
  49
  50 I personally would like to have the same vim configuration on all my accounts.
  51 Still, on certain machines I would like to personalize and specialize the
  52 configuration. The following files are read if existent:
  53
  54   - plugins-local.vim
  55   - macros-local.vim
  56   - keymaps-local.vim
  57   - init-local.vim
  58
  59 Example files are shipped with the repository.
  60
  61
  62 ## Terminal color settings
  63
  64 For consistent background colors you may change the background colors of your
  65 terminal program to the gruvbox black #1c1c1c. Otherwise regions of your
  66 terminal may appear in a saturated black (#000) rather than the gruvbox black.