summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRanke Johannes <johannes.ranke@agroscope.admin.ch>2023-06-20 10:04:38 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2023-06-20 11:38:27 +0200
commit4497059f39ebf982f39434cadffa3819f7cb421e (patch)
treeaa63f372c16e1253eaefc8c0b0e2c0817c3e47b7 /README.md
parentcc4ed2995f32e7bb0190c72999cf33fca1774f16 (diff)
Improve README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 10 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6339a3c..a13f9cb 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,16 @@ cd dotfiles
make
```
-This will download the [vim-plug](https://github.com/junegunn/vim-plug) plugin
-manager from github if not already present at .vim/autoload. To install the
-plugins, open vim and type
+This will call the [install]{install} script from this repository, which links
+each configuration file from the dotfiles directory to a dotfile in the users
+home directory.
+
+Also, it links vim configuration files to the respective
+nvim configuration files, installs the official git prompt,
+installs scripts from the bin directory into the users
+bin directory, and finally installs the
+[vim-plug](https://github.com/junegunn/vim-plug) plugin manager from github if
+not already present at .vim/autoload. To install the plugins, open vim and type
```vim
:PlugInstall

Contact - Imprint