diff options
author | Silvio Rhatto <rhatto@riseup.net> | 2013-12-28 13:29:40 -0200 |
---|---|---|
committer | Silvio Rhatto <rhatto@riseup.net> | 2013-12-28 13:29:40 -0200 |
commit | 3f145c0dfe21cc3d9d477d980d2322a728732753 (patch) | |
tree | 3b3267120b51e960e500f1e06086dc9b6fd5205a /README.mdwn | |
parent | 0c8cbbc0ea7c6ae56758f21c5678a44c1e1888f2 (diff) | |
download | metadot-3f145c0dfe21cc3d9d477d980d2322a728732753.tar.gz metadot-3f145c0dfe21cc3d9d477d980d2322a728732753.tar.bz2 |
Enhancing 'update', adding 'clone' and 'create'
Diffstat (limited to 'README.mdwn')
-rw-r--r-- | README.mdwn | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/README.mdwn b/README.mdwn index b3c0560..0eabca7 100644 --- a/README.mdwn +++ b/README.mdwn @@ -8,27 +8,39 @@ By being modular, it's possible to create modules for specific applications (vim, mutt, emcas, git, etc). By using git submodules, one can even create her own dotfile bundle. -Inspired by [holman does dotfiles](https://github.com/holman/dotfiles) and many -other initiatives but with a modular design to ease dotfile sharing as the -`metadot` code is split from the dotfile folder. +It was inspired by [holman does dotfiles](https://github.com/holman/dotfiles) +and many other initiatives but with a modular design to ease dotfile sharing as +the `metadot` code is split from the dotfile folder. Instalation ----------- Get the code: - git clone --recursive git://git.sarava.org/metadot.git + git clone git://git.sarava.org/metadot.git Save the metadot repository anywhere but make sure it's available in your `$PATH`. -Then get some modules. You can get the whole standard module bundle with: +Then get some modules. You can get the whole standard module bundle with - git clone --recursive git://git.sarava.org/rhatto/dotfiles.git ~/.dotfiles + metadot clone git://git.sarava.org/rhatto/dotfiles.git -This bundle will hardly suit all your needs. You can fetch individual modules or even -start your own bundle: +Modules names as `dotfiles` have a special meaning and are handled like bundles +and are cloned directly as `~/.dotfiles`. - mkdir -p ~/.dotfiles/modules - git clone --recursive git://git.sarava.org/rhatto/dotfiles/vim.git ~/.dotfiles/modules/vim +Third-party bundled modules will hardly suit your needs, so you can fetch +individual modules: + + metadot clone git://git.sarava.org/rhatto/dotfiles/vim.git + +Or even start your own: + + metadot create vim + +In both cases your `vim` module will be available at `~/.dotfiles/modules/vim`. + +You can use just one bundle at a time. While you can mixed a bundle with +individual modules, it's more sane to just start your own bundle and keep +modules as git submodules. Usage ----- @@ -45,7 +57,7 @@ Load all modules: metadot load --all -Update a module bundle: +Update a module bundle or all individual modules: metadot update |