Skip to content

Commit

Permalink
groups: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DavHau committed Nov 7, 2023
1 parent 0e36d8d commit edda831
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions modules/dream2nix/groups/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
Module to deal with package sets (so called groups in dream2nix)


## Separate different kinds of dependencies

Many language specific package managers support declaration of different kinds of dependencies like, for example:
Expand All @@ -27,6 +26,12 @@ For example, a new group could be assembled by referring to the `modules` of exi
```nix
{config, dream2nix, ...}: {
# TODO: This is too complex. Defining a selector function should be enough to
# assemble new groups.
# Any specifics about a package other than it's `ecosystem`, `name, `version
# are not important, as everything else is expressed via override modules.
# Simply naming the keys of packages should be sufficient to assemble groups.
# The dev group
groups.dev = {
Expand All @@ -42,7 +47,6 @@ For example, a new group could be assembled by referring to the `modules` of exi
# a modified hello package depending on the original hello definition
packages.hello-mod."1.0.0".module = {
blabla = {inherit wuhu;};
imports = [
# import the module definition of `hello` from above
config.groups.dev.packages.hello.module
Expand All @@ -65,3 +69,8 @@ For example, a new group could be assembled by referring to the `modules` of exi
}
}
```

## TODOs

- Expose all package candidates somehow (not grouped)
- Create groups by simply defining `selector` functions instead of referring to other group's packages modules.

0 comments on commit edda831

Please sign in to comment.