summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Luper Rouch <luper.rouch@gmail.com> 2013-02-09 15:21:09 +0100
committerGravatar Luper Rouch <luper.rouch@gmail.com> 2013-02-09 15:21:09 +0100
commit874926074b973240973ea822400b825a6158e018 (patch)
treeb893ad3630b3a78008432cd43d93cc055612c890
parent532b90b85ea2431202e9797869dabc069b064fe2 (diff)
downloaddotfiles-874926074b973240973ea822400b825a6158e018.tar.gz
dotfiles-874926074b973240973ea822400b825a6158e018.tar.bz2
dotfiles-874926074b973240973ea822400b825a6158e018.zip
updated readme
-rw-r--r--README.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index c496cb7..8357768 100644
--- a/README.rst
+++ b/README.rst
@@ -36,6 +36,9 @@ Interface
``-m, --move``
Move dotfiles repository to another location.
+For all commands you can use the ``--dry-run`` option, which will print actions
+and won't modify anything on your drive.
+
Installation
------------
@@ -143,6 +146,21 @@ I have the following in my ``~/.dotfilesrc``: ::
Any file you list in ``ignore`` will be skipped. The ``ignore`` option supports
glob file patterns.
+Packages
+--------
+
+Most recent programs store their configuration in ``~/.config``. It's quite
+cluttered and you probably don't want to keep all its content in your
+repository. For this situation you can use the ``packages`` setting::
+
+ [dotfiles]
+ packages = ['config']
+
+This tells ``dotfiles`` that the contents of the ``config`` subdirectory of
+your repository must be symlinked to ``~/.config``. If for example you have a
+directory ``config/awesome`` in your repository, it will be symlinked to
+``~/.config/awesome``.
+
Contribute
----------