Skip to content

Commit

Permalink
readme: mention cdToProjectRoot
Browse files Browse the repository at this point in the history
Resolves #34
  • Loading branch information
srid authored May 9, 2023
1 parent c2f3f0a commit a0c93bd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Available commands:

Once you are in the dev shell, you can run any of these scripts prefixed with the wrapper name `,`. For example, `, fmt` to format the Nix files.

The scripts will be run *always* from the project root directory[^flake-root] regardless of the current working directory.
Note: The scripts will *always* be run from the project root directory[^flake-root] regardless of the current working directory. You can disable this behaviour by setting the `cdToProjectRoot` option to `false`.

[^flake-root]: "Project root directory" is determined by traversing the directory up until we find the unique file that exists only at the root. This unique file is `flake.nix` by default, which can be overridden using the [flake-root](https://github.com/srid/flake-root) module that this module mandatorily requires; i.e.; `flake-root.projectRootFile = "stack.yaml";`

Expand Down

0 comments on commit a0c93bd

Please sign in to comment.