]> git.sthu.org Git - vimconf.git/blob - README.md
plugins: Load latex-unicoder unconditionally
[vimconf.git] / README.md
1 # A modular vim configuration
2
3 This is my personal vim configuration that is partly inspired by
4 [SpaceVim](https://spacevim.org/). It is compatible to vim, gvim (8.0+) and
5 neovim (0.2+). The configuration is split up into multiple files such that
6 personal customization is separated from boilerplate code.
7
8 ![A demo screenshot](https://www.sthu.org/code/codesnippets/img/vimconf-start-plugin.png)
9
10
11 <div class="hideonwebsite">
12 This repository is a replication of the repository <a
13 href="https://git.sthu.org/?p=vimconf.git;a=summary">here</a>. The <a
14 href="https://www.sthu.org/code/codesnippets/vimconf.html">website</a> gives
15 further details and more screenshots.
16 </div>
17
18 ## Installation
19
20 ### Requirements
21
22 The install script that is shipped with this configuration also checks
23 for the following requirements:
24
25 - python3 support for vim/gvim
26 - neovim python3 module
27 - aspell
28
29 Under a Debian-like Linux system you can install these by the following commands
30
31 ````
32 sudo apt-get install aspell aspell-de python3-pip
33 pip3 install neovim
34 ````
35
36 Note that vim-tiny in Debian does not support python3, but vim-nox, vim-gtk3 or
37 neovim does. You also want to make sure that you have curl and git installed.
38
39 ### Clone & install
40
41 If you already have a vim configuration in place then you may first move your
42 `~/.vim` directory first
43
44 ````
45 mv ~/.vim ~/.vim-old
46 ````
47
48 Assuming that there is no `~/.vim` anymore, simply clone this repository into
49 `~/.vim` and invoke `install.sh` therein.
50
51 ````
52 git clone https://git.sthu.org/repos/vimconf.git ~/.vim
53 ~/.vim/install.sh
54 ````
55
56 This install script creates backups of existing configuration files (e.g.,
57 `~/.vimrc`) and then creates symlinks to configuration files in `~/.vim`.
58
59
60 ## Specialization for local machines
61
62 I personally would like to have the same vim configuration on all my user
63 accounts. Still, on certain machines I would like to personalize and specialize
64 the configuration. The following files are sourced if existent:
65
66 - plugins-local.vim
67 - macros-local.vim
68 - keymaps-local.vim
69 - init-local.vim
70
71 Example files are shipped with the repository.
72
73
74 ## Terminal color settings
75
76 For consistent background colors you may change the background colors of your
77 terminal program to the gruvbox black #1c1c1c. Otherwise regions of your
78 terminal may appear in a saturated black (#000) rather than the gruvbox black.