diff options
author | Jon Bernard <jbernard@tuxion.com> | 2011-06-04 19:05:39 -0400 |
---|---|---|
committer | Jon Bernard <jbernard@tuxion.com> | 2011-06-04 19:05:39 -0400 |
commit | 0de25186f02b089b024d47414a82351d03c28350 (patch) | |
tree | 8f25b04e2423e47e4e79adb62961493a9db107c7 /README.rst | |
parent | 23d8a721bf84c2b531bca0b9babc6359a7803092 (diff) | |
download | dotfiles-0de25186f02b089b024d47414a82351d03c28350.tar.gz dotfiles-0de25186f02b089b024d47414a82351d03c28350.tar.bz2 dotfiles-0de25186f02b089b024d47414a82351d03c28350.zip |
Update documentation to mention config file syntax
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 24 |
1 files changed, 20 insertions, 4 deletions
@@ -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 `<http://dotfiles.org>`_ 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 `<http://dotfiles.org>`_ 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 ------- |