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 Note that vim-tiny in Debian does not support python3, but vim-nox, vim-gtk3 or
  28 neovim does. You also want to make sure that you have curl and git installed.
  29
  30 ### Clone & install
  31
  32 If you already have a vim configuration in place then you may first move your
  33 ~/.vim directory first
  34
  35 ````
  36 mv ~/.vim ~/.vim-old
  37 ````
  38
  39 Assumung that there is ~/.vim anymore, simply clone this repository into ~/.vim
  40 and invoke install.sh therein.
  41
  42 ````
  43 git clone https://git.sthu.org/repos/vimconf.git ~/.vim
  44 ~/.vim/install.sh
  45 ````
  46
  47 This install script creates backups of existing configuration files (e.g.,
  48 ~/.vimrc) and then creates symlinks to configuration files in ~/.vim.
  49
  50
  51 ## Specialization for local machines
  52
  53 I personally would like to have the same vim configuration on all my accounts.
  54 Still, on certain machines I would like to personalize and specialize the
  55 configuration. The following files are read if existent:
  56
  57   - plugins-local.vim
  58   - macros-local.vim
  59   - keymaps-local.vim
  60   - init-local.vim
  61
  62 Example files are shipped with the repository.
  63
  64
  65 ## Terminal color settings
  66
  67 For consistent background colors you may change the background colors of your
  68 terminal program to the gruvbox black #1c1c1c. Otherwise regions of your
  69 terminal may appear in a saturated black (#000) rather than the gruvbox black.