From 4497059f39ebf982f39434cadffa3819f7cb421e Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Tue, 20 Jun 2023 10:04:38 +0200 Subject: Improve README --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3 From abb0dc93dae4709bdfddffe323691d8eb1a9e451 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Tue, 20 Jun 2023 11:40:46 +0200 Subject: Fix markup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index a13f9cb..31724de 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ cd dotfiles make ``` -This will call the [install]{install} script from this repository, which links +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. -- cgit v1.2.3