My personal configuration files and directories. Files/directories are stored without their "." prefix. Symlink/include these files to their expected location on the host system. This repo should be cloned into ~/dotfiles
by convention.
Dotfiles that aren't platform-specific should live in this root directory; platform-specific ones should live inside a directory specific to that platform.
bashrc
- bash shell configuration file. Include it in~/.bashrc
like so:
source ~/dotfiles/bashrc
gitconfig
- Only contains configuration that is shared inside and outside of work (email field is excluded). Include this file in the OS.gitconfig
like so:
[include]
path = ~/dotfiles/gitconfig
-
gitignore
- Global git ignore. No setup required; included automatically bygitconfig
-
Brewfile
- Mac OShomebrew
packages. Generated withbrew bundle dump
. Link and install:
In ~/:
ln -s ~/dotfiles/Brewfile Brewfile
brew bundle install
tmux.conf
- tmux settings. Link it like so:
In ~/:
ln -s ~/dotfiles/tmux.conf .tmux.conf
vimrc
- vim settings. Include it in ~/.vimrc like so:
source ~/dotfiles/vimrc
-
scripts
- A directory of handy scripts. Include the "setupAliases" file in .bashrc/.zshrc to configure aliases to them. The aliases script is already included inshrc
. -
shrc
- Common shell configuration including aliases etc. Don't include this file directly in a shell config - make a shell-specific config file, and include this one. Loads aliases from dockerfiles repo if it's checked out. -
zshrc-pre
- zsh config script that gets run before oh-my-zsh is loaded (if using). Includes oh-my-zsh settings. Limit to zsh-specific commands that must occur before oh-my-zsh is loaded. -
zshrc-post
- zsh config script that gets sourced after oh-my-zsh is loaded (if using). Includes common shell config fromshrc
. Limit to zsh-specific commands; anything compatible with multiple shells should go inshrc
instead.
Load zshrc config files in .zshrc
like so:
source ~/dotfiles/zshrc-pre
# load oh-my-zsh here e.g.
# source $ZSH/oh-my-zsh.sh
source ~/dotfiles/zshrc-post