about summary refs log tree commit diff
path: root/.nixery/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2021-08-06T11·07+0300
committertazjin <mail@tazj.in>2021-08-06T13·24+0000
commit3be6eed241bff1bd8c146158d15ed78e39a74d40 (patch)
tree6f6573ba7d2d855f7805308867163a9a4f847ee7 /.nixery/README.md
parent9d087b327451adbd5e8d17c9dffee16ab1b70f9e (diff)
feat(.nixery): Add Nixery-compatible, importable folder r/2707
See the contained README for details.

Change-Id: I2870e260b17eda483308f7f884d13bab4db542ed
Reviewed-on: https://cl.tvl.fyi/c/depot/+/3277
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
Diffstat (limited to '.nixery/README.md')
-rw-r--r--.nixery/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/.nixery/README.md b/.nixery/README.md
new file mode 100644
index 000000000000..176209130023
--- /dev/null
+++ b/.nixery/README.md
@@ -0,0 +1,13 @@
+Nixery set
+==========
+
+This folder exports a special import of the depot Nix structure that is
+compatible with Nixery, by extending nixpkgs with a `tvl` attribute containing
+the depot.
+
+This is required because Nixery expects its package set to look like nixpkgs at
+the top-level.
+
+In the future we might want to patch Nixery to not require this (e.g. make it
+possible to pass `third_party.nixpkgs` as a key at which to find the nixpkgs
+structure).