Add README

2026-06-29 11:27:50 +02:00
parent 5002a409f9
commit 634f4950f0
1 changed files with 23 additions and 0 deletions
@@ -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 <repo> ~/.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
+