git clone https://github.com/stkao05/dotfiles <DOTPATH>
Edit zsh/zshrc.symlink
to specify the the path of this dotfile (<DOTPATH>
)
export ZSH=<DOTPATH>
Run bootstrap script to setup the shell environments
script/bootstrap
The script does the following
- Setup git config if no local git config is presented
- Scan for all
*.symlink
and create symbolic links
Run install script installing all things specified in install.sh
(i.e. all apps from /homebrew/install.sh
)
script/install
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/*.symlink: Any files ending in
*.symlink
get 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
.
On many keyboards, the CAPS LOCK key sits right next to the a key on the home row of the keyboard. By remapping this key to CTRL , you can make triggering commands more comfortable.
System Preferences --> Keyboard --> Modifier Keys
git/gitconfig.local.symlink
: contains config that might have private info (i.e. email). This file fille be ignoredgit/gitconfig.symlink
: will include config fromgit/gitconfig.local.symlink
plus additional config. This is the final config file that will be used by git