aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README5
-rw-r--r--README.md9
2 files changed, 9 insertions, 5 deletions
diff --git a/README b/README
deleted file mode 100644
index 927b883..0000000
--- a/README
+++ /dev/null
@@ -1,5 +0,0 @@
-rm -f xcolour-dotfiles-*.tar.gz
-wget --no-check-certificate https://www.github.com/xcolour/dotfiles/tarball/master
-tar zxfv xcolour-dotfiles-*.tar.gz
-cd xcolour-dotfiles-*/
-./deploy.sh
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fd7aa1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+Check out the repo somewhere and then run `deploy.sh` from inside the repo.
+
+The script will back up any existing dotfiles to `$REPODIR/dotfiles-backup/`
+and then replace the dotfiles in question with symlinks into the repo. It will
+also create a file called `.zshrc-local` (if one doesn't already exist) where
+you can set up an custom local behavior. Take a look inside the file for ideas.
+
+Once you have the symlinks set up, all you have to do to get updates is `git
+pull`, the symlinks will take care of the rest!