Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.18 KB

README.md

File metadata and controls

33 lines (26 loc) · 1.18 KB

Install

Run this:

git clone https://github.com/nhat/dotfiles.git ~/.dotfiles
cd ~/.dotfiles
bootstrap

This will symlink the appropriate files in .dotfiles to your home directory. Everything is configured and tweaked within ~/.dotfiles.

Components

dot is a simple script that installs some dependencies, sets sane macOS defaults, and so on. Run dot from time to time to keep your environment fresh and up-to-date. You can find this script in bin/.

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 run script/bootstrap.