aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d9ff1e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# dotfiles
+
+Managed with [GNU Stow](https://www.gnu.org/software/stow/).
+Each top-level directory is a stow *package* whose contents mirror the layout under `$HOME`.
+
+## Install
+
+This repo lives outside `$HOME`, so pass the target explicitly:
+
+```sh
+cd ~/git/dotfiles
+stow -t "$HOME" bash emacs mako
+```
+
+## Remove
+
+```sh
+cd ~/git/dotfiles
+stow -D -t "$HOME" bash emacs mako
+```
+
+## Restow (after moving/renaming files)
+
+```sh
+stow -R -t "$HOME" bash emacs mako
+```