dotfiles

The dotfiles we use when pairing.

Uses the homesick format.

Installation

Installing on OS X: Warning, Warning Will Robinson!

Using the stock OSX version of git will likely cause problems. You probably want to brew install git and ensure that /usr/local/bin precedes /usr/bin in your $PATH. You may also want to brew install vim (if you don't, you'll run into a bug in vim that causes it to crash with the message Caught deadly ABRT signal).

First Setup

curl -L https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh
gem install homesick
homesick clone    benjaminoakes/homesick-vi-everywhere
homesick clone    ContinuityControl/dotfiles
homesick symlink  homesick-vi-everywhere
homesick symlink  dotfiles

Optional

If you're going to use hitch or other ruby scripts in our dotfiles, install gem dependencies by installing bundler (gem install bundler), and then running bundle in the dotfiles directory:

cd ~/.homesick/repos/dotfiles/home
bundle

NOTE: if you use rvm, this will only install these gems for the environment specified by the .ruby-{version,gemfile}. You may need to switch to a different version of ruby.

Git Submodules

In order for vim plugins (and a couple tmux ones) to work correctly, you have to go through a few steps.

Enter your git user details into ~/.gitconfig.d/user and make sure you have an ssh key added to Github.

[user]
  name = [YOUR NAME HERE]
  email = [YOUR EMAIL HERE]

Run git submodule update from the ~/.homesick/repos/dotfiles/home/.vim/bundle directory.

If at this point you have a bunch of unstaged changes in the gitsubmodule directories, this is a known quirk with submodules and can be fixed. Until you do, opening vim will likely result in a bunch of errors.

Note: These steps assume that the unstaged changes are a bunch of deletions in each submodule directory. If this is not the case for you, then modify the foreach commands to execute the correct git commands to undo the changes you have.

Run git submodule foreach --recursive git reset
Run git submodule foreach --recursive git co .

Updates

homesick pull     homesick-vi-everywhere
homesick pull     dotfiles
homesick symlink  homesick-vi-everywhere
homesick symlink  dotfiles

Updating

cd ~/.homesick/repos/dotfiles
bundle

Personal dotfiles

If you want to track personal dotfiles that are gitignored, here is an approach. (Not final, but see the note about tmux.)

Make a private repo (username/my-dotfiles) with the private dotfiles you want to track. It should have a structure like this:

.
└── home
    ├── .personal
    │   ├── bin
    │   │   ├── foo
    │   │   └── bar
    │   ├── gitconfig.d
    │   │   └── user
    │   ├── tmux
    │   │   └── user.conf
    │   ├── vim
    │   │   └── spell
    │   │       ├── en.utf-8.add
    │   │       └── en.utf-8.add.spl
    │   └── zsh
    │       └── local.zsh
    └── .vimrc.local

Then add another homesick castle, after you set up benjaminoakes/homesick-vi-everywhere and ContinuityControl/dotfiles.

homesick clone username/my-dotfiles
homesick symlink my-dotfiles --force

(Note: you can't call it username/dotfiles because that would conflict with ContinuityControl/dotfiles. Also, be aware that conflicting paths will overwrite. It's best to keep personal dotfiles in .personal for this reason.)

Then add these files (for now, more improvements coming later):

$ cat ~/.zsh/local.zsh
source "$HOME/.personal/zsh/local.zsh"
$ cat ~/.gitconfig.d/user
[include]
  path = ~/.personal/gitconfig.d/user
$ cat ~/.tmux/user.conf
source-file "$HOME/.personal/tmux/user.conf"

(These are still gitignored, but at least they'll stay tiny.)

Future direction

The zsh and git configs could be made to look in .personal and skip if it doesn't exist (allowing this idea to be pulled up into this repository), but unfortunately tmux complains when it can't source a file, which is why we went this route for now.

treznick/dotfiles