diff --git a/README.md b/README.md index 9f0c212..6ba33f5 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,8 @@ it is converted to an attribute set equivalent to `{ root = theArg; }`. | `buildInputs` | Extra `buildInputs` to all derivations. Default: `[]` | | `cargoOptions` | Options passed to all cargo commands, i.e. `cargo ...`. These options can be accessed during the build through the environment variable `cargo_options`.
Note: these values are not (shell) escaped, meaning that you can use environment variables but must be careful when introducing e.g. spaces.
The argument must be a function modifying the default value.
Default: `[ "-Z" "unstable-options" ]` | | `doDoc` | When true, `cargo doc` is run and a new output `doc` is generated. Default: `false` | +| `cargoDocCommands` | The commands to run in the `docPhase`. Do not forget to set `doDoc`. The argument must be a function modifying the default value.
Default: `[ ''cargo $cargo_options doc $cargo_doc_options'' ]` | +| `cargoDocOptions` | Options passed to cargo doc, i.e. `cargo doc `. These options can be accessed during the build through the environment variable `cargo_doc_options`.
Note: these values are not (shell) escaped, meaning that you can use environment variables but must be careful when introducing e.g. spaces.
The argument must be a function modifying the default value.
Default: `[ "--offline" "$cargo_release" ''-j "$NIX_BUILD_CORES"'' ]` | | `release` | When true, all cargo builds are run with `--release`. The environment variable `cargo_release` is set to `--release` iff this option is set. Default: `true` | | `override` | An override for all derivations involved in the build. Default: `(x: x)` | | `overrideMain` | An override for the top-level (last, main) derivation. If both `override` and `overrideMain` are specified, _both_ will be applied to the top-level derivation. Default: `(x: x)` | diff --git a/README.tpl.md b/README.tpl.md index 5a31b84..260dab4 100644 --- a/README.tpl.md +++ b/README.tpl.md @@ -78,7 +78,7 @@ naersk.buildPackage ./my-package Initialize flakes within your repo by running: ``` bash -nix flake init github:nmattia/naersk +nix flake init -t github:nmattia/naersk nix flake lock ```