docs: add more depth to Flake input
authorโทสฺตัล <redacted>
Thu, 23 Jan 2025 10:08:42 +0000 (17:08 +0700)
committerโทสฺตัล <redacted>
Sat, 1 Feb 2025 17:46:56 +0000 (00:46 +0700)
commit72a93d13683a54210fe5900af78cbdfc7255dce8
tree737d150ee2c79c4396705989125e980a20364bb2
parent8ca227e21a43ad28d978aadff2da75f1bbd90e98
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
readme_template.md
git clone https://git.99rst.org/PROJECT