From 94543309a05ba7bafafd9ac00e10e2977006c2b8 Mon Sep 17 00:00:00 2001 From: GlennIgen Date: Tue, 2 Dec 2025 19:42:11 +0100 Subject: [PATCH] add installation instructions to README.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index e69de29..e57210b 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,20 @@ +## Installation (stow on Linux) + +Assuming the repository is already present locally (e.g., at ~/.dotfiles): + +1. From the repo root, run: +``` +cd ~/.dotfiles +stow . +``` +- Running `stow .` from the repo root is sufficient; no `--target` is needed. +- Preview changes with `stow -n .` before applying. + +2. Optional — set fish as your login shell: +``` +chsh -s "$(which fish)" "$USER" +``` + +Notes: +- Resolve any file conflicts before running `stow` (move or remove existing files). +- This repository is private; manage updates using your preferred method.