summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGravatar Jon Bernard <jbernard@tuxion.com> 2013-02-09 21:24:27 -0500
committerGravatar Jon Bernard <jbernard@tuxion.com> 2013-02-09 21:24:27 -0500
commit4db331138d9ef9d2ae66dacaea108f57822fabfd (patch)
tree40ff5cf786dac0f6ff2774eeda7bae9dde8fa30f /README.rst
parent4e271e534ee5ec19f1cd76f384186a8d71352422 (diff)
downloaddotfiles-4db331138d9ef9d2ae66dacaea108f57822fabfd.tar.gz
dotfiles-4db331138d9ef9d2ae66dacaea108f57822fabfd.tar.bz2
dotfiles-4db331138d9ef9d2ae66dacaea108f57822fabfd.zip
Update packages section in README
This commit adds a note about current limitations and explains what currently works and what remains a todo item.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 13 insertions, 3 deletions
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
----------