Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated readme

  • Loading branch information...
commit ebe0bace73cb683f955a0e1c726e7fe5946f0a09 1 parent 4dfab88
@mivok authored
Showing with 10 additions and 0 deletions.
  1. +10 −0 README.md
View
10 README.md
@@ -15,6 +15,11 @@ separate git repository. This allows you to share some of your configuration
in on repository (for example, just your vim configuration), while keeping
another private.
+One of the key requirements for homedir.sh was limited dependencies, only a
+bash shell, git and standard shell commands are required. For situations where
+even git isn't available, you can use rsync instead to send a copy of your
+dotfiles from a different machine.
+
## Getting started
Each collection is simply a git repository with a directory called 'home' in
@@ -82,6 +87,11 @@ location than locally such as `/usr/local/bin`. If you get an error about
being unable to find rsync, then you can pass the `-r` option to homedir.sh to
tell it where rsync is installed to on the remote host.
+When sending collections via rsync, homedir.sh drops a copy of itself in the
+dotfiles directory (`~/.dotfiles` by default). While this is used for
+generating the symlinks, you can also use it yourself to manage collections,
+or send them to other machines as needed.
+
### Inactive collections
If you use the send command, and make use of multiple collections, you may
Please sign in to comment.
Something went wrong with that request. Please try again.