diff --git a/README.md b/README.md index 961cad0..a7fe4a6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ -# dotfiles +# config -## Setup a bare git repo +This repo stores nix, dotfiles, and other miscellaneous scripts. -```shell -git clone --bare git@github.com:davegallant/dotfiles.git $HOME/.dotfiles -alias config='git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME' # add alias to a .bashrc or .zshrc -source ~/.zshrc || source ~/.bashrc -config config --local status.showUntrackedFiles no -# override all config files -config checkout -f +## Setup + +Clone this as a bare repo to avoid the need for symlinking: + +```console +$ git clone --bare git@github.com:davegallant/config.git $HOME/.dotfiles +$ alias config='git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME' # add alias to a .bashrc or .zshrc +$ source ~/.zshrc +$ config config --local status.showUntrackedFiles no +$ config checkout -f # this will overwrite any existing configs in the home directory ```