aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPeter Geissler <peter@haxx.in>2026-08-26 23:29:54 +0200
committerPeter Geissler <peter@haxx.in>2026-08-26 23:30:58 +0200
commit91526fe1f3482f610b38caa214a91f78564f7d50 (patch)
tree5bc1005f0a6838bdb093877d59c0615ffaab23fc /README.md
parentmake install: put the binary and the examples where they belong (diff)
downloadslosh-91526fe1f3482f610b38caa214a91f78564f7d50.tar.gz
slosh-91526fe1f3482f610b38caa214a91f78564f7d50.tar.xz
slosh-91526fe1f3482f610b38caa214a91f78564f7d50.zip
homebrew: a formula, and a script that keeps it honest
`brew install slosh` is the shortest install there is, and the formula is small because `make install` already does the work: zig as the only build dependency, both zig caches redirected into the build directory so the sandbox does not deny them and the user's real cache is not polluted, and the commit id handed to the Makefile because a snapshot tarball has no .git for `git describe` to read. The url/version/sha256 triple is the part that rots. contrib/brew-release resolves a ref to a full commit id, fetches the cgit snapshot, hashes what it actually got, and rewrites those three stanzas -- it does not commit or push, so the diff is read by a human first. Untagged pins carry the commit count so `brew upgrade` can tell newer from older; alphabetical comparison of two short ids cannot. The formula lives here as the source of truth and is copied into the tap; contrib/homebrew/README.md says why it is a formula and not a cask, and what still stands between this and homebrew-core.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index ec1e636..bbd6887 100644
--- a/README.md
+++ b/README.md
@@ -21,8 +21,15 @@ C on top of [libghostty-vt](https://github.com/ghostty-org/ghostty).
## Install
-Needs [zig](https://ziglang.org) 0.16 and nothing else. The result is one static
-binary.
+With [Homebrew](https://brew.sh) (macOS or Linux):
+
+```bash
+brew tap sl0p/slosh https://git.sl0p.foo/homebrew-slosh.git
+brew install slosh
+```
+
+From source it needs [zig](https://ziglang.org) 0.16 and nothing else. The
+result is one static binary.
```bash
make vendor # the vendored terminal core, once