Skip to content

stuartc/dotfiles

 
 

Repository files navigation

dotfiles

Your dotfiles are how you personalize your system. These are mine.

I was a little tired of having long alias files and everything strewn about (which is extremely common on other dotfiles projects, too). That led to this project being much more topic-centric. I realized I could split a lot of things up into the main areas I used (Ruby, git, system libraries, and so on), so I structured the project accordingly.

If you're interested in the philosophy behind why projects like these are awesome, you might want to read my post on the subject.

install

Run this:

git clone https://github.com/stuartc/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap

This will symlink the appropriate files in .dotfiles to your home directory. Everything is configured and tweaked within ~/.dotfiles.

The main file you'll want to change right off the bat is zsh/zshrc.symlink, which sets up a few paths that'll be different on your particular machine.

dot is a simple script that installs some dependencies, sets sane OS X defaults, and so on. Tweak this script, and occasionally run dot from time to time to keep your environment fresh and up-to-date. You can find this script in bin/.

A goal of these dotfiles is to be *nix agnostic, currently I'm using this on both Ubuntu (Server & Desktop), and OSX. There's been quite a lot of small tweaks in order to get vim, tmux and the various shells around to play nicely.

Granted the zsh environment has been sourced properly, everything should work.

topical

Everything's built around topic areas. If you're adding a new area to your forked dotfiles — say, "Java" — you can simply add a java directory and put files in there. Anything with an extension of .zsh will get automatically included into your shell. Anything with an extension of .symlink will get symlinked without extension into $HOME when you run script/bootstrap.

what's inside

  • My vim setup (mvim/gvim/vim compatible)
  • ZSH
  • Tmux config (with mouse support)
  • Some git aliases by default (st,ci,co)

... lots more.

components

There's a few special files in the hierarchy.

  • bin/: Anything in bin/ will get added to your $PATH and be made available everywhere.
  • topic/*.zsh: Any files ending in .zsh get loaded into your environment.
  • topic/path.zsh: Any file named path.zsh is loaded first and is expected to setup $PATH or similar.
  • topic/completion.zsh: Any file named completion.zsh is loaded last and is expected to setup autocomplete.
  • topic/*.symlink: Any files ending in *.symlink get symlinked into your $HOME. This is so you can keep all of those versioned in your dotfiles but still keep those autoloaded files in your home directory. These get symlinked in when you run script/bootstrap.

thanks

I forked @holman's excellent dotfiles, which I believe were based on @rbates' dotfiles.

Releases

No releases published

Packages

No packages published

Languages

  • Shell 52.1%
  • Ruby 45.0%
  • CSS 1.8%
  • Other 1.1%