divnix/digga
1
1
Fork 0
mirror of https://github.com/divnix/digga.git synced 2024-11-23 20:22:04 +03:00
Code Issues Projects Releases Wiki Activity

README.md: clarify overlays better

Browse Source
This commit is contained in:
Timothy DeHerrera 2020-01-06 00:16:21 -07:00
parent 395be3f74c
commit 32381093ad
No known key found for this signature in database
GPG Key ID: 8985725DB5B0C122
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -151,20 +151,21 @@ only be imported from the `users` or [`hosts`](hosts) directory.
## Modules, Packages and Overlays
All expressions in both [modules/defualt.nix](modules/default.nix) and
[pkgs/default.nix](pkgs/default.nix) are available globally, anywhere else in the
repo. They are additionally included in the `nixosModules` or `overlays` flake
outputs. Packages can manually be added to [flake.nix](flake.nix) for inclusion
in the `packages` output as well.
All overlays should be defined in the [overlays](overlays) directory. They will
be automatically pulled in for use by all configurations. Nix command line tools
will be able to read overlays from here as well since it is set as
`nixpkgs-overlays` in `NIX_PATH`.
repo. They are additionally included in the `nixosModules` and `overlay` flake
outputs, respectively. Packages can manually be added to [flake.nix](flake.nix)
for inclusion in the `packages` output as well.
The directory structure is identical to nixpkgs to provide a kind of staging area
for any modules or packages we might be wanting to merge there later. If your not
familiar or can't be bothered, simply dropping a valid nix file and pointing the
`default.nix` to it, is all that's really required.
As for overlays, they should be defined in the [overlays](overlays) directory.
They will be automatically pulled in for use by all configurations. Nix command
line tools will be able to read overlays from here as well since it is set as
`nixpkgs-overlays` in `NIX_PATH`. And of course they will be exported via the
flake output `overlays` as well.
# License
This software is licensed under the [MIT License](COPYING).