I forked the excellent Zach Holman dotfiles because it offered a robust framework to extend.
If you're interested in the philosophy behind why projects like these are awesome, you might want to read my post on the subject.
Everything is built around topic areas. If you are 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 be automatically included in your shell. Anything with an extension of .symlink
will be 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. - 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/holman/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
script/bootstrap
script/install
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. Also, there are some configurations that assume this folder lives on $HOME/.dotfiles
, so you might want to also change those.
dot
is a simple script that installs some dependencies, sets sane macOS 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/
.