Skip to content

Commit

Permalink
docs: flakular rename
Browse files Browse the repository at this point in the history
  • Loading branch information
srid committed Nov 17, 2023
1 parent 94d8021 commit f0d2860
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ TODO

## A note on process working directory

The `dataDir` of these services tend to take *relative* paths, which are usually relative to the project root. As such, when you run these services using `nix run`, their data files are created relative to whichever directory you are in. If you want these data files to always reside relative to the project directory, instead of using `nix run` consider wrapping the process-compose packages in script, via either [mission-control](https://zero-to-flakes.com/mission-control/) module or a [justfile](https://just.systems/). The example uses the latter.
The `dataDir` of these services tend to take *relative* paths, which are usually relative to the project root. As such, when you run these services using `nix run`, their data files are created relative to whichever directory you are in. If you want these data files to always reside relative to the project directory, instead of using `nix run` consider wrapping the process-compose packages in script, via either [mission-control](https://flakular.in/mission-control/) module or a [justfile](https://just.systems/). The example uses the latter.

## Contributing

- If you are adding a *new* service, see https://github.com/cachix/devenv/tree/main/src/modules/services for inspiration.
- For contributing to docs, see https://zero-to-flakes.com/about#contributing
- For contributing to docs, see https://flakular.in/about#contributing

## Credits

Expand Down
2 changes: 1 addition & 1 deletion dev/flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
nativeBuildInputs = [
pkgs.just
];
# cf. https://zero-to-flakes.com/haskell-flake/devshell#composing-devshells
# cf. https://flakular.in/haskell-flake/devshell#composing-devshells
inputsFrom = [
config.treefmt.build.devShell
];
Expand Down

0 comments on commit f0d2860

Please sign in to comment.