diff --git a/README.markdown b/README.markdown index 048ccbf..f23b3ba 100644 --- a/README.markdown +++ b/README.markdown @@ -14,12 +14,29 @@ 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 + +Requirements +------------ + +Python 2.7. It might work (or could easily be made to work) with 2.6 and 3.x +as well but I haven't tried. + + +Installation +------------ + + pip install dotfilemanager + + +Usage +----- + +`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 +`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