From 6b9187673ee62d11042832f938913f15131592a7 Mon Sep 17 00:00:00 2001
From: Silvio Rhatto <rhatto@riseup.net>
Date: Fri, 1 Feb 2013 01:25:10 -0200
Subject: Adding metadot script

---
 README.mdwn | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

(limited to 'README.mdwn')

diff --git a/README.mdwn b/README.mdwn
index 32db541..52fd0af 100644
--- a/README.mdwn
+++ b/README.mdwn
@@ -1,6 +1,8 @@
 Metadot: a dotfile management system
 ====================================
 
+Inspired by https://github.com/holman/dotfiles
+
 Instalation
 -----------
 
@@ -14,11 +16,24 @@ Backups of your old files can be put into .dotfiles/backups.
 Layout
 ------
 
-- ~/.dotfiles/
-  - modules: where all dotfiles plugins are stored
-  - backups: backups of old config files
+- ~/.dotfiles: where all dotfiles plugins are stored
+- ~/.backups: backups of old config files
 - ~/.custom: your custom configuration where you can override parameters
 
+Module format
+-------------
+
+Modules rest at ~/.dotfiles/modules and can be git submodules. File format is:
+
+    [path/]<name>[.dot][.link]
+
+That means:
+
+- 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.
+
 Todo
 ----
 
-- 
cgit v1.2.3