summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohannes Ranke <johannes.ranke@jrwb.de>2026-03-19 09:29:36 +0100
committerJohannes Ranke <johannes.ranke@jrwb.de>2026-03-19 09:29:36 +0100
commit91b23ed582f4a1dda87e93d799acbc28a4490b55 (patch)
tree2f72c1ebbf88ecfe6c76685d346edb359ac95645 /README.md
parente27d787f385ee4c975bf8b534e888d6a485eceb9 (diff)
parentb11292b7ac7d8efd10a5dc09fc8ac5896cd26725 (diff)
Merge branch 'main' into nvim-luanvim-lua
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4fb9708..80ad034 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,20 @@ cd dotfiles
make
```
+The [install](install) script from this repository links
+each configuration file from the dotfiles directory to a dotfile in the users
+home directory.
+
If you have previously managed your vim plugins as in the former version of
my dotfiles, i.e. using a link from the `.vim` directory to `.config/nvim`,
you need to remove that link before running `make`, as a new link from
`dotfiles/nvim` to `.config/nvim` will be created.
+
+The install script also installs scripts from the bin directory into the users
+`.local/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