ephase/dotinstall
Archived
1
0
Fork 0
Code Issues Pull requests Releases 1 Wiki Activity

Update dosumentation

Browse source
This commit is contained in:
Yorick Barbanneau 2021-11-23 17:24:51 +01:00
parent 94e1996ed4
commit 419c895408
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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.