mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-11 09:39:17 +00:00
Code Activity

update readme

Browse Source
This commit is contained in:
deadc0de6
2019-02-02 22:47:17 +01:00
parent 27f32fd703
commit 8442904006
1 changed files with 10 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -546,11 +546,11 @@ config file.
The second symlink method allows to have every files/directories under `src` to The second symlink method allows to have every files/directories under `src` to
be symlinked in `dst`. It is enabled by setting `link_children: true`. be symlinked in `dst`. It is enabled by setting `link_children: true`.
### link children ### Link children
This feature can be very useful for dotfiles when you don't want the entire This feature can be very useful for dotfiles when you don't want the entire
directory to be symlink but still want to keep a clean config files (with a directory to be symlink but still want to keep a clean config files (with a
limited number of entry). limited number of entries).
A good example of its use is when managing `~/.vim` with dotdrop. A good example of its use is when managing `~/.vim` with dotdrop.
@@ -559,10 +559,7 @@ directory `~/.vim` is symlinked to the *dotpath* location (here `~/.dotfiles/vim
```yaml ```yaml
vim: vim:
dst: ~/.vim/ dst: ~/.vim/
src: ./vim/ src: vim
actions:
- vim-plug-install
- vim-plug
link: true link: true
``` ```
@@ -579,18 +576,15 @@ dotdrop (including unwanted directories like `spell`, `swap`, etc).
A cleaner solution is to use `link_children` which allows to only symlink specific A cleaner solution is to use `link_children` which allows to only symlink specific
files under the dotfile directory. Let's say only `after`, `plugin`, `snippets`, and `vimrc` files under the dotfile directory. Let's say only `after`, `plugin`, `snippets`, and `vimrc`
need to be managed in dotdrop. `~/.vim` is imported in dotdrop, cleaned off all unwanted need to be managed in dotdrop. `~/.vim` is imported in dotdrop, cleaned off all unwanted
files and directories and then the `link_children` entry is set to `true`. files and directories and then the `link_children` entry is set to `true` in the config file.
All children of the `vim` directory in the *dotpath* will be symlinked under `~/.vim/` Now all children of the `vim` dotfile's directory in the *dotpath* will be symlinked under `~/.vim/`
without affecting the rest of the local files, keeping the config file clean without affecting the rest of the local files, keeping the config file clean
and all unwanted files only on the local system. and all unwanted files only on the local system.
```yaml ```yaml
vim: vim:
dst: ~/.vim/ dst: ~/.vim/
src: ./vim/ src: vim
actions:
- vim-plug-install
- vim-plug
link_children: true link_children: true
``` ```
@@ -599,14 +593,14 @@ $ readlink -f ~/.vim
~/.vim ~/.vim
$ tree -L 1 ~/.vim $ tree -L 1 ~/.vim
~/.vim ~/.vim
├── after -> /.dotfiles/./vim/after ├── after -> ~/.dotfiles/vim/after
├── autoload ├── autoload
├── plugged ├── plugged
├── plugin -> /.dotfiles/./vim/plugin ├── plugin -> ~/.dotfiles/vim/plugin
├── snippets -> /.dotfiles/./vim/snippets ├── snippets -> ~/.dotfiles/vim/snippets
├── spell ├── spell
├── swap ├── swap
└── vimrc -> /.dotfiles/./vim/vimrc └── vimrc -> ~/.dotfiles/vim/vimrc
``` ```
### Templating symlinked dotfiles ### Templating symlinked dotfiles