From: Someone Serge <redacted>
Date: Sun, 21 Jan 2024 03:41:37 +0000 (+0000)
Subject: flake.nix: add a comment about flakes vs nix
X-Git-Tag: upstream/0.0.4488~2537
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=b2d80e105a59b54822edf7ce7f3ed5f317e96e21;p=pkg%2Fggml%2Fsources%2Fllama.cpp

flake.nix: add a comment about flakes vs nix
---

diff --git a/flake.nix b/flake.nix
index ec62c773..a776ba02 100644
--- a/flake.nix
+++ b/flake.nix
@@ -1,3 +1,17 @@
+# The flake interface to llama.cpp's Nix expressions. The flake is used as a
+# more discoverable entry-point, as well as a way to pin the dependencies and
+# expose default outputs, including the outputs built by the CI.
+
+# For more serious applications involving some kind of customization  you may
+# want to consider consuming the overlay, or instantiating `llamaPackages`
+# directly:
+#
+# ```nix
+# pkgs.callPackage ${llama-cpp-root}/.devops/nix/scope.nix { }`
+# ```
+
+# Cf. https://jade.fyi/blog/flakes-arent-real/ for a more detailed exposition
+# of the relation between Nix and the Nix Flakes.
 {
   description = "Port of Facebook's LLaMA model in C/C++";