aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGravatar Jon Bernard <jbernard@tuxion.com> 2011-11-01 12:47:34 -0400
committerGravatar Jon Bernard <jbernard@tuxion.com> 2011-11-01 12:47:34 -0400
commit05970aa663f75692c127715ee78ea101a34734d9 (patch)
tree86ae32ebd32c972c1a4e622b3708acf636eeb58b /README.rst
parent95426bbf4c23001a10538dee1f27b39dcac4b952 (diff)
parentf7a7bf7b3b2c751a2092adbff16c3f041084679b (diff)
downloaddotfiles-05970aa663f75692c127715ee78ea101a34734d9.tar.gz
dotfiles-05970aa663f75692c127715ee78ea101a34734d9.tar.bz2
dotfiles-05970aa663f75692c127715ee78ea101a34734d9.zip
Merge branch 'release/0.5.0'v0.5.0
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst33
1 files changed, 9 insertions, 24 deletions
diff --git a/README.rst b/README.rst
index 0509f1f..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
--------
@@ -131,26 +136,6 @@ I have the following in my ``~/.dotfilesrc``: ::
Any file you list in ``ignore`` will be skipped. The ``ignore`` option supports
glob file patterns.
-License
--------
-
-GPL License. ::
-
- Copyright (C) 2011 Jon Bernard
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
-
Contribute
----------