From: โทสฺตัล <redacted>
Date: Thu, 23 Jan 2025 10:08:42 +0000 (+0700)
Subject: docs: add more depth to Flake input
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=72a93d13683a54210fe5900af78cbdfc7255dce8;p=stevenblack-hosts.git

docs: add more depth to Flake input

At present, if a user copy-pastes the current documentation, a version
of Nixpkgs will be added to their ``flake.lock`` lockfile. This is
probably not what the user wants as Nixpkgs, the tarball, is quite large
& the user likely expects the StevenBlack Flake to be used as a module
to just be using the Nixpkgs of the system.

This change should also help new Nix users know how to pin a Nix version
if there ever comes a time where the Nix :ac:`API` changes—even if ``lib``
tries to be stable & backwards-compatible.

Additionally, provide a comment about where & what the input can be—such
as a mirror or a local fork for development.

Format: text/x-rst
---

diff --git a/readme_template.md b/readme_template.md
index b9e134fce..af3df4140 100644
--- a/readme_template.md
+++ b/readme_template.md
@@ -386,7 +386,14 @@ like this:
 
 ```nix
 {
-  inputs.hosts.url = "github:StevenBlack/hosts";
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=$YOUR-REF";
+    hosts = {
+      url = "github:StevenBlack/hosts"; # or a fork/mirror
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
   outputs = { self, nixpkgs, hosts }: {
     nixosConfigurations.my-hostname = {
       system = "<architecture>";