diff options
| author |  Jon Bernard <jbernard@jbernard.io>
| 2016-10-13 13:16:26 -0400 |
|---|---|---|
| committer | Jon Bernard <jbernard@jbernard.io>
| 2016-10-13 13:16:26 -0400 |
| commit | e3074dc8ea384275fb1cd1430b38ceb3e50ba0fc (patch) | |
| tree | f1f9ad57e3c4964e25b80b4ce2ed0e61ffa3d5c0 /README.rst | |
| parent | d3a3f8910a7ef07b464c9d5432917943b19e6d7b (diff) | |
| download | dotfiles-e3074dc8ea384275fb1cd1430b38ceb3e50ba0fc.tar.gz dotfiles-e3074dc8ea384275fb1cd1430b38ceb3e50ba0fc.tar.bz2 dotfiles-e3074dc8ea384275fb1cd1430b38ceb3e50ba0fc.zip | |
Rework the readme a bit, still much to do
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 42 |
1 files changed, 22 insertions, 20 deletions
@@ -1,7 +1,25 @@ -*Update:* I've managed to find some free time recently and have been making -some changes and improvements that hopefully people will appreciate. At the -moment the ``master`` branch is in a state of flux until I get all of the -pieces included. +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 up to you. You can use a VCS like git, Dropbox, or even rsync to +distribute your dotfiles repository across multiple hosts. + +The repository can be specified at runtime, so you can manage multiple +repositories without hassle. See the Configuration_ section below for further +details. + +Directories are supported as well. Any file object in your home directory that +starts with a ``.`` is fair game. + +Recent Changes +-------------- + +I've managed to find some free time recently and have been making some changes +and improvements that hopefully people will appreciate. At the moment the +``master`` branch is in a state of flux until I get all of the pieces included. Feel free to use the latest stable version ``0.6.4`` on pypi if that's what you're looking for. @@ -20,22 +38,6 @@ released soon. There are some changes in interface and behaviour from the previous version and I hope it doesn't frustrate folks too much. Feel free to submit an issue if you find something intolerable. -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 up to you. You can use a VCS like git, Dropbox, or even rsync to -distribute your dotfiles repository across multiple hosts. - -The repository can be specified at runtime, so you can manage multiple -repositories without hassle. See the Configuration_ section below for further -details. - -Directories are supported as well. Any file object in your home directory that -starts with a ``.`` is fair game. - Interface --------- |