From dbe2a273f6589baf06de3b0555b924d3d88e5989 Mon Sep 17 00:00:00 2001 From: Sean Hammond Date: Sat, 1 May 2010 00:55:06 +0100 Subject: [PATCH] Add usage instructions to top of README. --- README.markdown | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.markdown b/README.markdown index c0631c6..feaeda6 100644 --- a/README.markdown +++ b/README.markdown @@ -5,6 +5,21 @@ Python and tweaked the behaviour a bit. [Steve Kemp's dotfile manager]: http://blog.steve.org.uk/i_ve_got_a_sick_friend__i_need_her_help_.html +`dotfilemanager link` Make a symlink in your homedir to each top-level +file and directory in `~/.dotfiles`. + +`dotfilemanager tidy` Delete any broken symlinks in your homedir. + +`dotfilemanager report` Report on what link or tidy would do, but don't +actually create or delete any symlinks. + +Optionally you can specify the directories to link from and to as +arguments, usage: + + dotfilemanager link|tidy|report [FROM_DIR [TO_DIR]] + +* * * + The idea is that you have some folder called the `TO_DIR` (defaults to `~/.dotfiles`), where you move all the dotfiles that you want to manage, e.g.