My version of dotfiles.
⚡️ — as of macOS 10.15 Catalina, zsh
is used as the default login and interactive shell. it is expected this is being ran on a zsh
shell.
The structure and files are heavily sourced from Zach Holman's excellent dotfiles.
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/
will get added to your $PATH
and be made
available everywhere..zsh
get loaded into your
environment.path.zsh
is loaded first and is
expected to setup $PATH
or similar.completion.zsh
is loaded
after path and is expected to setup autocomplete.setup.zsh
is loaded
last.install.sh
is executed when you run script/install
. To avoid being loaded automatically, its extension is .sh
, not .zsh
.*.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 run script/bootstrap
.Run this:
git clone https://github.com/borwahs/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 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/
.