From 8a370b9c9d1616f4582c2fa53afa682bbf5c42d8 Mon Sep 17 00:00:00 2001 From: xenia Date: Sun, 1 Dec 2024 23:25:04 -0500 Subject: [PATCH] update readme --- README.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f052d37..9ca4398 100644 --- a/README.md +++ b/README.md @@ -41,10 +41,22 @@ for flake usage, add this repo as an input and don't input nixpkgs at all, since } ``` -note that overriding inputs to the flake won't necessarily work because of the way nixpkgs registers -itself with the system. this requires really annoying hacks to get working at all. if you want to -depend on `dragnpkgs` with a different version of `nixpkgs` (ie not 24.11 or unstable), clone the -repo and recreate `flake.lock`. aren't flakes so cool and fun!!!! +note that the dragnpkgs module sets a couple defaults -- see module.nix and the inline modules in +flake.nix for details +- disables nixpkgs self-registration in the flake registry and nix path and enables a + dragnpkgs-specific registration mechanism for these that is enabled by default, see + `options.dragnpkgs` +- in flake.nix but not in module.nix: disable channels +- add lix cache and its keys to substitutors +- enable experimental features `nix-command flakes repl-flake` +- disable the default flake registry. i think it's cringe +- add a repl overlay that adds some useful utilities to `nix repl` -- see repl-overlay.nix for + details + +also note that overriding inputs to the flake won't necessarily work because of the way nixpkgs +registers itself with the system. this requires really annoying hacks to get working at all. if you +want to depend on `dragnpkgs` with a different version of `nixpkgs` (ie not 24.11 or unstable), +clone the repo and recreate `flake.lock`. aren't flakes so cool and fun!!!! ## options documentation