From 622ae91a72b4097bd4d7178592d64efdb0281c61 Mon Sep 17 00:00:00 2001 From: Matt Singleton Date: Mon, 19 Dec 2011 03:09:35 -0500 Subject: update the readme --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fd7aa1e..ebcab4f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,26 @@ -Check out the repo somewhere and then run `deploy.sh` from inside the repo. +## Installation -The script will back up any existing dotfiles to `$REPODIR/dotfiles-backup/` +You're going to want to make changes, so before you do anything, fork this repo +and make it your own. + +Clone it somewhere on your local machine: + + $ git clone git://github.com/xcolour/dotfiles.git ~/.dotfiles + +I use Pathogen with git sumbodules to manage vim plugins, so clone the plugins +too (if you care about vim): + + $ cd ~/.dotfiles + $ git submodule update --init + +This next step is supposed to back up your existing dotfiles before replacing +them, but since you're smart and I'm just some random guy on the internet, +you'll back up anything you care about by hand first and you won't blame me if +anything goes wrong. Once that's done, you're ready to install your dotfiles: + + $ sh deploy.sh + +This 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! +you can set up any custom local behavior. Take a look inside the file for ideas. -- cgit v1.2.3