From: Silvio Rhatto <rhatto@riseup.net>
Date: Fri, 1 Feb 2013 03:37:07 +0000 (-0200)
Subject: Better layout explanation
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=e8c28ff3866376c292efb5152de4e63f8891c774;p=metadot.git

Better layout explanation
---

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