From 298547f72be9ea788dd29aaff63584fff6ede9e5 Mon Sep 17 00:00:00 2001
From: Tim Culverhouse <tim@timculverhouse.com>
Date: Tue, 6 May 2025 15:13:34 -0500
Subject: [PATCH] readme: add installation instructions

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 58befa0..dcbbc2f 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,18 @@
 
 ![screenshot](screenshot.png)
 
+## Installation
+
+`lsr` uses the zig build system. To install, you will need zig 0.14.0. To
+install for the local user (assuming $HOME/.local/bin is in $PATH), run:
+
+```sh
+zig build -Doptimize=ReleaseSmall --prefix $HOME/.local
+```
+
+which will install `lsr` and the associated manpage appropriately. Replace
+`$HOME/.local` with your preferred installation directory.
+
 ## Benchmarks
 
 Benchmarks were all gathered on the same set of directories, using the latest
-- 
2.51.2