From 3e5d2dcc546217202d99f2b471081707d357d23c Mon Sep 17 00:00:00 2001 From: "thomas g. lopes" Date: Wed, 11 Mar 2026 10:56:21 +0000 Subject: [PATCH] add install options to readme --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5980348..97ebc60 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,25 @@ Sigil is a minimal symlink-based dotfile manager with per-package Lua config. -## Install (dev) +## Install +### Build and install to ~/.local/bin +```bash +cd ~/programming/sigil +go build -o ~/.local/bin/sigil . ``` + +### Install via go install +```bash +cd ~/programming/sigil +go install . +# Binary will be at $(go env GOPATH)/bin/sigil +# Make sure $(go env GOPATH)/bin is in your PATH +``` + +### Run without installing (dev) +```bash +cd ~/programming/sigil go run . ```