aboutsummaryrefslogtreecommitdiff
path: root/README.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'README.mdwn')
-rw-r--r--README.mdwn18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.mdwn b/README.mdwn
new file mode 100644
index 0000000..ba53932
--- /dev/null
+++ b/README.mdwn
@@ -0,0 +1,18 @@
+Metadot: a dotfiles management system
+=====================================
+
+Instalation
+-----------
+
+ git clone git://URL/dotfiles.git .dotfiles
+
+Some configuration files depends on the "scripts" repository to
+be cloned at ~/apps/scripts
+
+Backups of your old files can be put into .config/metadot/backups/
+
+Layout
+------
+
+- modules: where all dotfiles plugins are stored
+- backups: backups of old config files