From 874926074b973240973ea822400b825a6158e018 Mon Sep 17 00:00:00 2001 From: Luper Rouch Date: Sat, 9 Feb 2013 15:21:09 +0100 Subject: updated readme --- README.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.rst') 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 ---------- -- cgit v1.2.3 From 4db331138d9ef9d2ae66dacaea108f57822fabfd Mon Sep 17 00:00:00 2001 From: Jon Bernard Date: Sat, 9 Feb 2013 21:24:27 -0500 Subject: Update packages section in README This commit adds a note about current limitations and explains what currently works and what remains a todo item. --- README.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 8357768..dca0e9b 100644 --- a/README.rst +++ b/README.rst @@ -149,9 +149,9 @@ 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:: +Many 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'] @@ -161,6 +161,16 @@ 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``. +This feature allows one additional level of nesting, but further subdirectories +are not eligible for being a package. For example, ``config`` is valid, but +``config/transmission`` is not valid. Arbitrary nesting is a feature under +current consideration. + +At the moment, packages can not be added or removed through the command line +interface. They must be constructed and configured manually. Once this is +done, ``sync``, ``list``, ``check``, and ``move`` will do the right thing. +Support for ``add`` and ``remove`` is a current TODO item. + Contribute ---------- -- cgit v1.2.3