From 0de25186f02b089b024d47414a82351d03c28350 Mon Sep 17 00:00:00 2001 From: Jon Bernard Date: Sat, 4 Jun 2011 19:05:39 -0400 Subject: Update documentation to mention config file syntax --- README.rst | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 6e71871..f8b9f9d 100644 --- a/README.rst +++ b/README.rst @@ -4,10 +4,10 @@ Dotfile management made easy ``dotfiles`` is a tool to make managing your dotfile symlinks in ``$HOME`` easy, allowing you to keep all your dotfiles in a single directory. -Hosting is left to you. Yes, I've seen ``_ and I don't -believe in that model. If you're advanced enough to need dotfile management, -then you probably already know how you want to host them. Using whatever VCS -you prefer, or even rsync, you can easily distribute your dotfiles repository +Hosting is left to you. Yes, I've seen ``_ but I don't +like that model. If you're advanced enough to need dotfile management, then you +probably already know how you want to host them. Using whatever VCS you +prefer, or even rsync, you can easily distribute your dotfiles repository across multiple hosts. Installation @@ -51,6 +51,22 @@ To make it available to all your hosts: :: You get the idea. +Configuration +------------- + +You can choose to create a configuration file to store personal +customizations. By default, ``dotfiles`` will look in ``~/.dotfilesrc``. An +example configuration file might look like: :: + + [dotfiles] + repository = ~/Dotfiles + ignore = [ + '.git', + '.gitignore'] + externals = { + '.bzr.log': '/dev/null', + '.uml': '/tmp'} + License ------- -- cgit v1.2.3