From 34905c293fd26c0a1bd2beaf10f077e34bf82abd Mon Sep 17 00:00:00 2001
From: loqusion <38332081+loqusion@users.noreply.github.com>
Date: Tue, 2 Jan 2024 15:55:48 -0600
Subject: [PATCH] feat(templates): add comments explaining each derivation

---
 examples/quick-start/flake.nix | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/examples/quick-start/flake.nix b/examples/quick-start/flake.nix
index da7b902..7868140 100644
--- a/examples/quick-start/flake.nix
+++ b/examples/quick-start/flake.nix
@@ -48,14 +48,22 @@
         ];
       };
 
+      # Compile a Typst project, *without* copying the result
+      # to the current directory
       build-drv = typstNixLib.buildTypstProject {
         inherit (commonArgs) src typstSource fontPaths localPaths;
       };
 
+      # Compile a Typst project, and then copy the result
+      # to the current directory
       build-script = typstNixLib.buildLocalTypstProject {
         inherit (commonArgs) src typstSource fontPaths localPaths;
       };
 
+      # Watch a project and recompile on changes
+      #
+      # *Warning*: Do not rely on this for reproducible output,
+      # as it is exposed to the user's environment
       watch-script = typstNixLib.watchTypstProject {
         inherit (commonArgs) typstSource fontPaths localPaths;
       };