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
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/install.sh: Any file named
install.shis executed when you run
script/install. To avoid being loaded automatically, its extension is
- topic/*.symlink: Any file ending in
*.symlinkgets 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
- Run this:
git clone https://github.com/offirgolan/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
- In a new terminal session run this:
This will run each topic's install script.
dot is a simple script that installs some dependencies, sets sane macOS
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