]> gitweb.fluxo.info Git - metadot.git/commitdiff
README update
authorSilvio Rhatto <rhatto@riseup.net>
Sat, 28 Dec 2013 15:32:37 +0000 (13:32 -0200)
committerSilvio Rhatto <rhatto@riseup.net>
Sat, 28 Dec 2013 15:32:37 +0000 (13:32 -0200)
README.mdwn

index 0eabca7c35f2e5ad06ee6e364f6b90ca21f2b449..c1e09a43aa42cc27b0ba626dd2f35d971d2594db 100644 (file)
@@ -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
 -------