diff options
| author | Silvio Rhatto <rhatto@riseup.net> | 2013-02-01 01:37:07 -0200 |
|---|---|---|
| committer | Silvio Rhatto <rhatto@riseup.net> | 2013-02-01 01:37:07 -0200 |
| commit | e8c28ff3866376c292efb5152de4e63f8891c774 (patch) | |
| tree | 7368ce3e0cf1ab8faef014a25ac5daf39a610375 | |
| parent | 6c5e43233130d8b12704f126ca80ceb7e226b5e2 (diff) | |
| download | dotfiles-e8c28ff3866376c292efb5152de4e63f8891c774.tar.gz dotfiles-e8c28ff3866376c292efb5152de4e63f8891c774.tar.bz2 | |
Better layout explanation
| -rw-r--r-- | README.mdwn | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/README.mdwn b/README.mdwn index fb625e0..ca192d8 100644 --- a/README.mdwn +++ b/README.mdwn @@ -16,7 +16,7 @@ Backups of your old files can be put into .dotfiles/backups. Layout ------ -- ~/.dotfiles: where all dotfiles plugins are stored +- ~/.dotfiles: where all dotfiles modules are stored - ~/.backups: backups of old config files - ~/.custom: your custom configuration where you can override parameters @@ -27,12 +27,16 @@ Modules rest at ~/.dotfiles/modules and can be git submodules. File format is: [path/]<name>[.dot][.link] -That means: +Which means files -- files ending with a .link extension are linked at $HOME. -- files with a .dot.link extension are converted to a dotfile: vimrc.dot.link is symlinked as ~/.vimrc -- file structure is preserved: file apps/scripts.link is linked at $HOME/apps/scripts. -- all other files are ignored. +- with a .link extension are linked at $HOME. +- with a .dot.link extension are converted to a dotfile: vimrc.dot.link is linked as ~/.vimrc. +- with other extensions are ignored. + +Also, + +- file structure is preserved: file apps/scripts.link is linked as $HOME/apps/scripts. +- nested structures are allowed: config.dot/awesome.link is linked as $HOME/.config/awesome Todo ---- |