aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNick Moore <nicholasvmoore@gmail.com>2026-11-07 07:54:23 -0600
committerNick Moore <nicholasvmoore@gmail.com>2026-11-07 07:54:23 -0600
commit34abcb44caf7266ce40063daca05a2a06f1b26c7 (patch)
tree1a5314d2dc82c79287d0cca965fad8ac2caee4ca /README.md
parent29d66a4100637e2f0221e0954eaf2ad8f2847ff0 (diff)
README: document stow deploy workflow
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 32 insertions, 1 deletions
diff --git a/README.md b/README.md
index 27ef622..1cc4c52 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,32 @@
-# dotfiles \ No newline at end of file
+# dotfiles
+
+Personal configuration, deployed as GNU stow packages. Each top-level
+directory is a package that mirrors `$HOME`, e.g.
+`waybar/.config/waybar/config.jsonc`.
+
+Machines currently represented:
+
+- **rigel** — Gentoo + sway laptop (waybar, tmux, nvim, alacritty are
+ synced from here; sway/ is pending)
+- **hypr** — Hyprland machines (hypr/ package)
+
+## Deploy (GNU stow)
+
+```sh
+git clone git.pcola.moorenix.com:git-public/dotfiles.git ~/git/dotfiles
+cd ~/git/dotfiles
+
+# see what would change first (-n = dry run):
+stow -n -v2 -t ~ waybar
+
+# stow for real; --adopt moves any existing target file into the package
+# and replaces it with a symlink (converts a live config to stow-managed):
+stow --adopt -t ~ waybar tmux nvim alacritty
+
+# sway: swaymsg reload after stow config changes
+```
+
+Not every package fits every machine — pick the ones matching that
+machine's stack. Per-tool conventions live in each package's `AGENTS.md`;
+repo-wide rules (secrets, hygiene, layout invariants) in the root
+`AGENTS.md`.