aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.mdwn24
-rwxr-xr-xmetadot4
2 files changed, 23 insertions, 5 deletions
diff --git a/README.mdwn b/README.mdwn
index ca192d8..714df16 100644
--- a/README.mdwn
+++ b/README.mdwn
@@ -6,12 +6,26 @@ Inspired by https://github.com/holman/dotfiles
Instalation
-----------
+Get the code:
+
git clone --recursive git://URL/dotfiles.git .dotfiles
-Some configuration files depends on the "scripts" repository to
-be cloned at ~/apps/scripts.
+Then add .dotfiles folder to your path.
+
+Usage
+-----
+
+List existing modules:
+
+ metadot ls
+
+Load a module:
+
+ metadot load <module>
+
+Load all modules:
-Backups of your old files can be put into .dotfiles/backups.
+ metadot load --all
Layout
------
@@ -41,5 +55,7 @@ Also,
Todo
----
-- Put modules as git submodules.
+- Make modules as git submodules.
- Better integration with scripts project.
+- Module descriptions.
+- Basic dependency.
diff --git a/metadot b/metadot
index f2bb2d7..8d8a4e5 100755
--- a/metadot
+++ b/metadot
@@ -1,6 +1,6 @@
#!/bin/bash
#
-# metadot: a dotfile manager
+# metadot: a dotfile management system
#
# Parameters
@@ -75,6 +75,8 @@ function metadot_load {
if [ -z "$OPT" ]; then
echo "usage: $BASENAME <option> [arguments]"
exit 1
+elif [ "$OPT" == "ls" ]; then
+ ls -1 $MODULES
elif [ "$OPT" == "update" ]; then
( cd $DOT && git pull origin master && git submodule update --init )
elif [ "$OPT" == "load" ]; then