nathan/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2026-10-02 13:00:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/readme: Simplify nix-direnv setup (#567379)

Browse Source
This commit is contained in:
Matt Sturgeon
2026-09-27 09:14:23 +00:00
committed by GitHub
parent 86acb4b240 9ac6245a02
commit 5fe040508f
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/README.md
View File

@@ -51,14 +51,16 @@ $ cd /path/to/nixpkgs/doc
$ nix-shell
```
To load the development utilities automatically when entering that directory, [set up `nix-direnv`](https://nix.dev/guides/recipes/direnv).
To load the documentation development environment automatically when entering that directory:
Make sure that your local files aren't added to Git history by adding the following lines to `.git/info/exclude` at the root of the Nixpkgs repository:
1. Install [`nix-direnv`](https://search.nixos.org/packages?channel=unstable&query=nix-direnv#show=nix-direnv)
1. Set up direnv in the documentation directory:
```
/**/.envrc
/**/.direnv
```
```ShellSession
$ cd doc
$ echo "use nix" > .envrc
$ direnv allow
```
#### Live preview