summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGravatar Jon Bernard <jbernard@tuxion.com> 2011-10-30 23:27:17 -0400
committerGravatar Jon Bernard <jbernard@tuxion.com> 2011-11-01 09:21:39 -0400
commit4584eb5790d42092ba1d3965ae987fef7b4d8c43 (patch)
treedda86e37f15d10a8a1373448c4996774a500415b /README.rst
parent6aec9c0e3c3e8a5e7718f5c34bb620462cb724f3 (diff)
downloaddotfiles-4584eb5790d42092ba1d3965ae987fef7b4d8c43.tar.gz
dotfiles-4584eb5790d42092ba1d3965ae987fef7b4d8c43.tar.bz2
dotfiles-4584eb5790d42092ba1d3965ae987fef7b4d8c43.zip
Add support for in-repo configuration files
In addition to parsing .dotfilesrc in the user's home directory, also look for that file inside the repository. This allows you to keep your repository and it's settings together. Closes: #1
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index d73beae..22813c5 100644
--- a/README.rst
+++ b/README.rst
@@ -4,7 +4,7 @@ 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. Using whatever VCS you prefer, or even rsync, you can
+Hosting is up to you. Using whatever VCS you prefer, or even rsync, you can
easily distribute your dotfiles repository across multiple hosts.
Interface
@@ -73,9 +73,9 @@ You get the idea. Type ``dotfiles --help`` to see the available options.
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: ::
+You can choose to create a configuration file to store personal customizations.
+By default, ``dotfiles`` will look for ``~/.dotfilesrc``. You can change this
+with the ``-C`` flag. An example configuration file might look like: ::
[dotfiles]
repository = ~/Dotfiles
@@ -87,6 +87,11 @@ example configuration file might look like: ::
'.bzr.log': '/dev/null',
'.uml': '/tmp'}
+You can also store your configuration file inside your repository. Put your
+settings in ``.dotfilesrc`` at the root of your repository and ``dotfiles`` will
+find it. Note that ``ignore`` and ``externals`` are appended to any values
+previously discovered.
+
Prefixes
--------