aboutsummaryrefslogtreecommitdiff
path: root/README.mdwn
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2013-12-28 13:32:37 -0200
committerSilvio Rhatto <rhatto@riseup.net>2013-12-28 13:32:37 -0200
commitbb90ab9033dd717576ccdbea388a3cab5088bd8e (patch)
tree1511880ad5ff36f0655e0d33b5f504e0ec3a9f12 /README.mdwn
parent3f145c0dfe21cc3d9d477d980d2322a728732753 (diff)
downloadmetadot-bb90ab9033dd717576ccdbea388a3cab5088bd8e.tar.gz
metadot-bb90ab9033dd717576ccdbea388a3cab5088bd8e.tar.bz2
README update
Diffstat (limited to 'README.mdwn')
-rw-r--r--README.mdwn14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.mdwn b/README.mdwn
index 0eabca7..c1e09a4 100644
--- a/README.mdwn
+++ b/README.mdwn
@@ -66,9 +66,9 @@ Backups are made whenever a module is loaded.
Layout
------
-- ~/.dotfiles: where all dotfiles modules are stored
-- ~/.backups: backups of old config files
-- ~/.custom: some modules use this folder for custom configuration overriding default parameters
+- `~/.dotfiles`: where all dotfiles modules are stored
+- `~/.backups`: backups of old config files
+- `~/.custom`: some modules use this folder for custom configuration overriding default parameters
Module format
-------------
@@ -79,14 +79,14 @@ Modules rest at ~/.dotfiles/modules and can be git submodules. File format is:
Which means files
-- 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 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
+- file structure is preserved: `apps/scripts.link` is linked as `$HOME/apps/scripts`.
+- nested structures are allowed: `config.dot/awesome.link` is linked as `$HOME/.config/awesome`.
Contact
-------