From 1a549007df607b7b0f3302c3096b807c90c6436b Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Fri, 2 May 2025 21:30:05 +0200 Subject: [PATCH] document the role of nix-index in the ecosystem --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6c55cd9..02f6c4b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -# nix-index -## A files database for nixpkgs -**nix-index** is a tool to quickly locate the package providing a certain file in [`nixpkgs`](https://github.com/NixOS/nixpkgs). It indexes built derivations found in binary caches. +# `nix-index` – a file database for Nixpkgs -###### Demo +`nix-index` is a tool to quickly locate the package providing a certain file in [`nixpkgs`](https://github.com/NixOS/nixpkgs). It indexes built derivations found in binary caches. + +It is used to [build the file index](https://github.com/NixOS/nixos-channel-scripts/pull/62) for official channel releases on and thus provides the basis for . + +## Demo ``` $ nix-locate 'bin/hello'