summaryrefslogtreecommitdiff
path: root/lib/fileset/README.md
diff options
context:
space:
mode:
authorSilvan Mosberger <silvan.mosberger@tweag.io>2023-10-03 18:50:03 +0200
committerSilvan Mosberger <silvan.mosberger@tweag.io>2023-10-03 18:50:18 +0200
commit43e4d8a6a1402c67420e7bad3ba8237c5f3ed327 (patch)
tree5a8d1888c0a66360e0f485c88f5b7f6ea8515bad /lib/fileset/README.md
parentMerge pull request #258803 from figsoda/changie (diff)
downloadnixpkgs-43e4d8a6a1402c67420e7bad3ba8237c5f3ed327.tar.gz
lib.fileset: Link to user documentation from contributor docs
Diffstat (limited to 'lib/fileset/README.md')
-rw-r--r--lib/fileset/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/fileset/README.md b/lib/fileset/README.md
index 2ef7b81e8850..76c1e8d3f2cb 100644
--- a/lib/fileset/README.md
+++ b/lib/fileset/README.md
@@ -1,5 +1,10 @@
# File set library
+This is the internal contributor documentation.
+The user documentation is [in the Nixpkgs manual](https://nixos.org/manual/nixpkgs/unstable/#sec-fileset).
+
+## Goals
+
The main goal of the file set library is to be able to select local files that should be added to the Nix store.
It should have the following properties:
- Easy: