X-Git-Url: https://git.sthu.org/?p=vimconf.git;a=blobdiff_plain;f=README.md;h=fef6bdc6e1e4949479ea09aaa4f26d019099c101;hp=36e411ffa8c647dea67472df32d8c11ba7c36729;hb=1b46ae546caf268e6cec40ede48ea45817c44dfa;hpb=0b8d10cf3795f7ce103de2165e3aae15c0f52ec7

diff --git a/README.md b/README.md
index 36e411f..fef6bdc 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,78 @@
 # A modular vim configuration
 
-This is my personal vim configuration that is partly inspired by SpaceVim. It
-is compatible to neovim and (g)vim (version 8 or higher). The configuration is
-split up into multiple files such that personal customization is separated from
-boilerplate code.
+This is my personal vim configuration that is partly inspired by
+[SpaceVim](https://spacevim.org/). It is compatible to vim, gvim (8.0+) and
+neovim (0.2+). The configuration is split up into multiple files such that
+personal customization is separated from boilerplate code.
 
+![A demo screenshot](https://www.sthu.org/code/codesnippets/img/vimconf-start-plugin.png)
+
+
+<div class="hideonwebsite">
+This repository is a replication of the repository <a
+href="https://git.sthu.org/?p=vimconf.git;a=summary">here</a>. The <a
+href="https://www.sthu.org/code/codesnippets/vimconf.html">website</a> gives
+further details and more screenshots.
+</div>
 
 ## Installation
 
-Simply clone this repository into ~/.vim and invoke install.sh therein. The
-install script just creates symlinks to vim/gvim/neovim configuration files and
-directories.
+### Requirements
+
+The install script that is shipped with this configuration also checks
+for the following requirements:
+
+  - python3 support for vim/gvim
+  - neovim python3 module
+  - aspell
+
+Under a Debian-like Linux system you can install these by the following commands
+
+````
+sudo apt-get install aspell aspell-de python3-pip
+pip3 install neovim
+````
+
+Note that vim-tiny in Debian does not support python3, but vim-nox, vim-gtk3 or
+neovim does. You also want to make sure that you have curl and git installed.
+
+### Clone & install
+
+If you already have a vim configuration in place then you may first move your
+`~/.vim` directory first
+
+````
+mv ~/.vim ~/.vim-old
+````
+
+Assuming that there is no `~/.vim` anymore, simply clone this repository into
+`~/.vim` and invoke `install.sh` therein.
 
 ````
 git clone https://git.sthu.org/repos/vimconf.git ~/.vim
 ~/.vim/install.sh
 ````
 
-The install file also checks requirements for the configuration and the plugins
-added:
-
-  - python3 support for vim/gvim
-  - neovim python3 module
-  - aspell
+This install script creates backups of existing configuration files (e.g.,
+`~/.vimrc`) and then creates symlinks to configuration files in `~/.vim`.
 
 
 ## Specialization for local machines
 
-I personally would like to have the same vim configuration on all my accounts.
-Still, on certain machines I would like to personalize and specialize the
-configuration. The following files are read if existent:
+I personally would like to have the same vim configuration on all my user
+accounts. Still, on certain machines I would like to personalize and specialize
+the configuration. The following files are sourced if existent:
 
   - plugins-local.vim
   - macros-local.vim
   - keymaps-local.vim
   - init-local.vim
 
-For all four example files are shipped with the repository.
+Example files are shipped with the repository.
+
+
+## Terminal color settings
+
+For consistent background colors you may change the background colors of your
+terminal program to the gruvbox black #1c1c1c. Otherwise regions of your
+terminal may appear in a saturated black (#000) rather than the gruvbox black.