Your dotfiles are how you personalize your system. These are mine.
If you're interested in the philosophy behind why projects like these are awesome, you might want to read Holman's post on the subject.
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
A lot of stuff. Seriously, a lot of stuff. Check them out in the file browser above and see what components may mesh up with you. Fork it, remove what you don't use, and build on what you do use.
There's a few special files in the hierarchy.
- bin/: Anything in
bin/will get added to your
$PATHand be made available everywhere.
- Brewfile: This is a list of applications for Homebrew Cask to install: things like Chrome and 1Password and Adium and stuff. Might want to edit this file before running any initial setup.
- topic/*.zsh: Any files ending in
.zshget loaded into your environment.
- topic/path.zsh: Any file named
path.zshis loaded first and is expected to setup
- topic/completion.zsh: Any file named
completion.zshis loaded last and is expected to setup autocomplete.
- topic/*.symlink: Any files ending in
*.symlinkget 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
git clone --recursive https://github.com/miguelff/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
The main file you'll want to change right off the bat is
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
time to time to keep your environment fresh and up-to-date. You can find
this script in
I want this to work for everyone; that means when you clone it down it should
work for you even though you may not have
rbenv installed, for example. That
said, I do use this as my dotfiles, so there's a good chance I may break
something if I forget to make a check for a dependency.
If you're brand-new to the project and run into any blockers, please open an issue on this repository and I'd love to get it fixed for you!
Thanks to Holman, because he came up with this framework. I just customized the little things I use differently.