I forked and modified this from Dan Schultz, who in turn started from Zach Holman's.
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
.
There's a few special files in the hierarchy.
- bin/: Anything in
bin/
will get added to your$PATH
and be made available everywhere. - Brewfile: This is a list of applications for Homebrew to install things like Chrome and 1Password and stuff. Edit this file before running any initial setup.
- 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/install.sh: Any file named
install.sh
is executed when you runscript/install
. To avoid being loaded automatically, its extension is.sh
, not.zsh
. - topic/*.symlink: Any file ending in
*.symlink
gets 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 runscript/bootstrap
.
Run this:
git clone https://github.com/reefdog/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
./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.