aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.mdwn16
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
----