nix-community/nix-direnv
1
0
Fork 0
mirror of https://github.com/nix-community/nix-direnv.git synced 2025-11-08 19:46:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: Clarify a stance on git-tracking the direnv layout directory.

Browse source 
Also took the liberty to update the wording in a way that I felt read a bit more smoothly.

closes #138
This commit is contained in:
Bryan Bennett 2022-04-07 09:58:57 -04:00
parent 1741888b4c
commit d3651bdd23
No known key found for this signature in database
GPG key ID: EF90E3E98B8F5C0B
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -209,14 +209,16 @@ $ direnv allow
## Storing .direnv outside the project directory
A `.direnv` directory will be created in each `use_nix` project, which might
interact badly with backups (e.g. Dropbox) or IDEs.
By default, every direnv-enabled directory will contain a `.direnv` directory.
`.direnv` acts as a pure cache and is fully reproducible.
To that end, we do not recommend tracking this directory or its contents,
even in the scenario that the project tracks the a `.direnvrc`.
Therefore it's possible to override a function called `direnv_layout_dir` in
`$HOME/.config/direnv/direnvrc` or in each project's `.envrc`.
It is possible to override a function called `direnv_layout_dir`
in `~/.config/direnv/direnvrc` (or in each project's `.direnvrc` or `.envrc`).
The following example will create a unique directory name per project
in `$HOME/.cache/direnv/layouts/`:
in `~/.cache/direnv/layouts/`:
```bash
# Place in "$HOME"/.config/direnv/direnvrc