From 419c89540817fe96cd6cb33435bec50079fdb547 Mon Sep 17 00:00:00 2001 From: Yorick Barbanneau Date: Tue, 23 Nov 2021 17:24:51 +0100 Subject: [PATCH] Update dosumentation --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7d7bc88..aa204e4 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ This function check if binary file is avaible in the `PATH`. required_commands "ls mv git" ``` -#### conf_process_dirs +#### link_dirs Process a directory that contains others directories an symblink them to the destination folder : @@ -68,10 +68,11 @@ destination folder : - **return** : no value, exit the funtion if there is an error on path ``` -conf_process_dirs "${repository}/config" "${HOME}/.config" +link_dirs "${repository}/config" "${HOME}/.config" ``` +Old function `conf_process_dirs` still avaiable for compatibility. -#### conf_process_files +#### link_files Process a directory than contains files and symblink them to the destination folder : @@ -82,9 +83,11 @@ folder : - **return** : no value, exit the funtion if there is an error on path ``` -conf_process_dirs "${repository}/zshrc" "${HOME}" +link_files "${repository}/zshrc" "${HOME}" ``` +Old function `conf_process_files` still avaiable for compatibility + #### bin_install Symblink an executable file to the `~/.local/bin` folder.