src/bin/paku: Explain how to have a file as overlay for Nix

1 files changed, 25 insertions, 1 deletions

diff --git a/src/bin/paku b/src/bin/paku
index 2cbca20..fcaf1ea 100755
--- a/src/bin/paku
+++ b/src/bin/paku
@@ -664,8 +664,32 @@ sub emit_html() {
 		  };</code></pre>
 		        <p>
 		          All the packages live under the
-		          <code>$overlay_name</code> attribute set.
+		          <code>$overlay_name</code> attribute set, like.
+		          <code>$overlay_name.$json->{packages}[0]->{name}</code>,
+		          so it can be included in the list of packages:
 		        </p>
+		        <pre><code>  environment.systemPackages = with pkgs; [
+		    ...
+		    $overlay_name.$json->{packages}[0]->{name}
+		  ];</pre></code>
+		        <p>
+		          To make the overlay available outside the system
+		          environment of
+		          <code>/etc/nixos/configuration.nix</code>, you need to
+		          add this overlay to your
+		          <code>~/.config/nixpkgs/overlays/</code> directory,
+		          like a
+		          <code>~/.config/nixpkgs/overlays/$json->{namespace}.nix</code>
+		          file containing:
+		        </p>
+		        <pre><code>import (fetchTarball {
+		  url = "$json->{vcs}->{tarball}";
+		}) { pkgs = import &lt;nixpkgs&gt; {}; }</pre></code>
+		        <p>
+		          Then you'd be able to launch a shell with a package
+		          from this overlay:
+		        </p>
+		        <pre><code>\$ nix-shell -p $overlay_name.$json->{packages}[0]->{name}</code></pre>
 		      </article>
 		      <article id="homebrew-instructions">
 		        <h2>Homebrew instructions</h2>