Kyle Gach's dotfiles

Your dotfiles are how you personalize your system and automate setup. These are mine.

What's Inside

A lot of stuff. Before blindly using, you should closely inspect the files yourself, fork this repo, remove what you don't use, and build on what you do use.

Topical Architecture

Everything's built around topic areas. If you're adding a new area to your forked dotfiles — say, "Go" — you can simply add a go directory and put files in there.

There are 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 run script/install. To avoid being loaded automatically, its extension is .sh, not .zsh.
• topic/*.symlink: Any file or folder ending in *.symlink gets symlinked into your $HOME. (e.g. [topic]/fileName.symlink -> ~/.fileName) 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.

Install

Run this:

git clone https://github.com/kylegach/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.

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. It is also automatically ran within script/bootstrap.

Where to Start Customizing

After forking this repo, the main files you'll want to change right off the bat are:

• zsh/zshrc.symlink: Sets up a few paths that'll be different on your particular machine
• homebrew/Brewfile: Defines the utilities and apps to be installed
• macos/setup-defaults.sh: Defines macOS defaults
• macos/Mackup: Defines third-party defaults. You'll probably want to replace these with your own

You'll probably also want to create a ~/.localrc (see example).

Bugs

I want this to work for everyone. 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. Please open an issue if you encounter any problems.

Thanks

I forked Zach Holman's clever dotfiles and grabbed a fair amount from Mathias Bynens' extensive dotfiles, particularly the incredibly helpful .macos.