From a5272f8ccc82b5a0ca7aa28cc0ccfefeec162a10 Mon Sep 17 00:00:00 2001
From: sterni <sternenseemann@systemli.org>
Date: Mon, 20 Jan 2025 23:30:39 +0100
Subject: [PATCH] =?UTF-8?q?docs(sterni/bl=C3=ABrg):=20list=20dependencies?=
 =?UTF-8?q?=20in=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Change-Id: Iceacf406bef71529cb29e8adcf9fe1f713187e42
Reviewed-on: https://cl.tvl.fyi/c/depot/+/13103
Autosubmit: sterni <sternenseemann@systemli.org>
Reviewed-by: sterni <sternenseemann@systemli.org>
Tested-by: BuildkiteCI
---
 users/sterni/blërg/README.md   | 14 ++++++++++++++
 users/sterni/blërg/blërg.bqn   |  8 ++------
 users/sterni/blërg/default.nix |  2 ++
 3 files changed, 18 insertions(+), 6 deletions(-)
 create mode 100644 users/sterni/blërg/README.md

diff --git a/users/sterni/blërg/README.md b/users/sterni/blërg/README.md
new file mode 100644
index 000000000..0717f4ce5
--- /dev/null
+++ b/users/sterni/blërg/README.md
@@ -0,0 +1,14 @@
+# blërg
+
+## dependencies
+
+- [CBQN][] (other [BQN][] implementations may work, but are untested)
+- //users/sterni/mn2html
+- [mblaze(7)][mblaze]
+- [execline][]
+- POSIX `printf(1)` (e.g. from GNU coreutils)
+
+[mblaze]: https://github.com/leahneukirchen/mblaze/
+[execline]: https://skarnet.org/software/execline/
+[BQN]: https://mlochbaum.github.io/BQN/
+[CBQN]: https://github.com/dzaima/cbqn
diff --git a/users/sterni/blërg/blërg.bqn b/users/sterni/blërg/blërg.bqn
index 8ba7ebe1f..4d7e46291 100755
--- a/users/sterni/blërg/blërg.bqn
+++ b/users/sterni/blërg/blërg.bqn
@@ -4,12 +4,8 @@
 #
 # blërg is a reimplementation of mblog in BQN. BQN is used as a sort of bespoke
 # scripting languages so we can rely on external tools for certain tasks (e.g.
-# transforming HTML and parsing MIME messages).
-#
-# Specifically, blërg depends on:
-# - mblaze
-# - mn2html
-# - execline (to work around the lack of cwd in BQN)
+# transforming HTML and parsing MIME messages). A list of dependencies is
+# maintained in README.md.
 
 # Utilities
 
diff --git a/users/sterni/blërg/default.nix b/users/sterni/blërg/default.nix
index f329fbdb4..8980b41a3 100644
--- a/users/sterni/blërg/default.nix
+++ b/users/sterni/blërg/default.nix
@@ -1,12 +1,14 @@
 { depot, pkgs, lib, ... }:
 
 let
+  # update README.md when changing this
   runtimeDependencies = [
     depot.users.sterni.mn2html
     pkgs.mblaze
     pkgs.execline # execline-cd
   ];
 
+  # … and this
   buildInputs = [
     pkgs.cbqn
   ];