diff options
| author | Matt Singleton <matt@xcolour.net> | 2014-02-08 19:00:32 -0500 |
|---|---|---|
| committer | Matt Singleton <matt@xcolour.net> | 2014-02-08 19:00:32 -0500 |
| commit | df46fb7d0fe0339c7cdae0511b03fbe9279231f0 (patch) | |
| tree | fd58a72f785f20d09e8827dd5bd78e55bd2e1e78 | |
| parent | 3c4757dda2cf7484e47e3bbb8b1d4b08370404d8 (diff) | |
update readme
| -rw-r--r-- | README.md | 27 | ||||
| -rw-r--r-- | zshrc-local | 3 |
2 files changed, 14 insertions, 16 deletions
@@ -5,20 +5,19 @@ 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: +Then run the deploy script: $ 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 any custom local behavior. Take a look inside the file for ideas. +This script does the following: + - Clear out `$PWD/dotfiles-backup/`. + - Back up any existing dotfiles to `$PWD/dotfiles-backup/`. + - Replace existing dotfiles with symlinks to the corresponding file in the + repo. + - Clone Vundle into `~/.vim/bundle/vundle/` and run `BundleInstall`. + will back up any existing dotfiles to `$PWD/dotfiles-backup/` + - Create `~/.zshrc-local` (if one doesn't already exist) for setting up local + behavior. Take a look inside for ideas. + +The prompt will highligh the local host name in red unless `ZSH_LOCAL_ENV=true` +is set. That's a good one for `~/.zshrc-local`. diff --git a/zshrc-local b/zshrc-local index 5b2e819..f809c5c 100644 --- a/zshrc-local +++ b/zshrc-local @@ -5,6 +5,5 @@ # get tex binaries on the path #export PATH=/usr/local/texlive/2009basic/bin/universal-darwin:$PATH -# if unset, certain shell features behave differently -# e.g. prompt hostname is highlighted in red for non-local envs +# prompt hostname is highlighted in red for non-local envs #export ZSH_LOCAL_ENV=true |