poz/nte
poz/nte
1
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve engine function argument docs

Browse source
This commit is contained in:
jacekpoz 2024-09-12 19:48:52 +02:00
parent 2f8dd60760
commit 9ee29045d0
Signed by: poz
SSH key fingerprint: SHA256:JyLeVWE4bF3tDnFeUpUaJsPsNlJyBldDGV/dIKSLyN8
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -46,9 +46,8 @@ then the engine function will be available under
```nix ```nix
inputs.nte.engines.${system}.default inputs.nte.engines.${system}.default
``` ```
it accepts 3 arguments: it accepts 2 arguments:
- `pkgs` - nixpkgs
- `src` - the directory containing all entries and templates - `src` - the directory containing all entries and templates
- an attrset of: - an attrset of:
- `extraArgs` - an attrset of additional arguments passed to all entries and templates - `extraArgs` - an attrset of additional arguments passed to all entries and templates
@ -57,14 +56,14 @@ it accepts 3 arguments:
and returns a string containing a shell script that applies the templates to the entries and returns a string containing a shell script that applies the templates to the entries
the flake gives the engine `pkgs`, so when passing the engine function to a derivation, only provide it with the source directory: when passing the engine function to the main derivation, only provide it with the source directory:
```nix ```nix
import ./project/default.nix { import ./project/default.nix {
# ... # ...
nte = nte.engines.${system}.default ./project; nte = nte.engines.${system}.default ./project;
}; };
``` ```
then you can use it as in the example derivation below: then you can pass the attrset and use it in that derivation, as in the example below:
```nix ```nix
{ {
nte, nte,