feat(templates): add comments explaining each derivation

loqusion · Jan 2, 2024 · 34905c2 · 34905c2
1 parent e2ec05a
commit 34905c2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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;
       };