Add support for gdb-dashboard

[vimconf.git] / README.md

diff --git a/README.md b/README.md
index 36e411ffa8c647dea67472df32d8c11ba7c36729..e088927d8a0ad018e332566777ac13c422a37aa1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +1,51 @@
 # 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
+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.
 
 
 ## 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
+````
+
+Assumung that there is ~/.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
@@ -36,4 +59,11 @@ configuration. The following files are read if existent:
   - 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.