diff --git a/README.md b/README.md new file mode 100644 index 0000000..b732fae --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# dotfiles + +Designed around [GNU stow][gnu stow manual]. +For `zsh` or `bash` (or both). Include `shell/` always. + +## Install + +```sh +git clone ~/.dotfiles +cd ~/.dotfiles +stow shell zsh # or: stow shell bash +``` + +## Update + +```sh +cd ~/.dotfiles +git pull +stow -R shell zsh # restow this host's packages +``` + +[gnu stow manual]: https://www.gnu.org/software/stow/manual/stow.html +