aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-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
----------