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.md: improve documentation

Browse source
This commit is contained in:
Jörg Thalheim 2020-04-10 13:44:40 +01:00
parent a95abd152a
commit f29fc205ce
No known key found for this signature in database
GPG key ID: 003F2096411B5F92
1 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -30,13 +30,29 @@ keep-derivations = true
keep-outputs = true keep-outputs = true
``` ```
## Storing .direnv outside the project directory
`.direnv` might interact badly with backups (i.e. Dropbox) or IDEs.
Therefore it's possible to override in `$HOME/.config/direnv/direnvrc` or
in own project's `.envrc` a variable called `$direnv_layout_dir`.
The following example will create a unique directory name per project
in `$HOME/.cache/direnv/layouts/`:
```bash
# $HOME/.config/direnv/direnvrc
: ${XDG_CACHE_HOME:=$HOME/.cache}
pwd_hash=$(echo -n $PWD | shasum | cut -d ' ' -f 1)
direnv_layout_dir=$XDG_CACHE_HOME/direnv/layouts/$pwd_hash
```
## Known Bugs ## Known Bugs
At the moment nix-direnv depends on gnugrep and a modern bash version. At the moment nix-direnv depends on gnugrep and a modern bash version.
This might lead to [problems](https://github.com/nix-community/nix-direnv/issues/3) on macOS. This might lead to [problems](https://github.com/nix-community/nix-direnv/issues/3) on macOS.
As a work-around we suggest to install direnv/grep via nix or homebrew. As a work-around we suggest to install direnv/grep via nix or homebrew.
## Why not using lorri instead. ## Why not using lorri instead?
Lorri causes large CPU load when `$NIXPKGS` is pointed to a directory, i.e. a Lorri causes large CPU load when `$NIXPKGS` is pointed to a directory, i.e. a
git checkout. This is because it tries to watch any referenced nix file and git checkout. This is because it tries to watch any referenced nix file and