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: restructure installation section

Browse source
This commit is contained in:
Jörg Thalheim 2020-09-26 08:02:32 +02:00
parent e8c54c3f64
commit c28d4ef615
No known key found for this signature in database
GPG key ID: 003F2096411B5F92
1 changed files with 45 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -11,40 +11,16 @@ Prominent features:
shell derivation in the user's `gcroots` (Life is too short to lose shell derivation in the user's `gcroots` (Life is too short to lose
your project's build cache if you are on a flight with no internet connection) your project's build cache if you are on a flight with no internet connection)
## Installation via Nix ## Installation
Since 20.03 you can install `nix-direnv` via nix: There are different ways to install nix-direnv, pick your favourite:
### NixOS - via home-manager (recommended)
- via configuration.nix in NixOS
- with nix-env
- from source
In `/etc/nixos/configuration.nix`: ### Via home-manager
```
{ pkgs, ... }: {
environment.systemPackages = with pkgs; [ nix-direnv ];
# nix options for derivations to persist garbage collection
nix.extraOptions = ''
keep-outputs = true
keep-derivations = true
'';
environment.pathsToLink = [
"/share/nix-direnv"
];
}
```
Then source the `direnvrc` from this repository in your own `.direnvrc`
```bash
# put this in ~/.direnvrc
source $HOME/.nix-direnv/direnvrc
if [ -f /run/current-system/sw/share/nix-direnv/direnvrc ]; then
source /run/current-system/sw/share/nix-direnv/direnvrc
fi
```
### Home-manager
In `$HOME/.config/nixpkgs/home.nix` add In `$HOME/.config/nixpkgs/home.nix` add
@ -79,7 +55,32 @@ keep-derivations = true
keep-outputs = true keep-outputs = true
``` ```
## Installation via nix-env ### Via configuration.nix in NixOS
In `/etc/nixos/configuration.nix`:
```
{ pkgs, ... }: {
environment.systemPackages = with pkgs; [ nix-direnv ];
# nix options for derivations to persist garbage collection
nix.extraOptions = ''
keep-outputs = true
keep-derivations = true
'';
environment.pathsToLink = [
"/share/nix-direnv"
];
}
```
Then source the `direnvrc` from this repository in your own `$HOME/.direnvrc`
```bash
# put this in ~/.direnvrc
source /run/current-system/sw/share/nix-direnv/direnvrc
```
### With nix-env
As **non-root** user do the following: As **non-root** user do the following:
@ -87,9 +88,16 @@ As **non-root** user do the following:
nix-env -f '<nixpkgs>' -iA nix-direnv nix-env -f '<nixpkgs>' -iA nix-direnv
``` ```
Then follow the home-manager installation except for the `$HOME/.config/nixpkgs/home.nix` changes. Then add nix-direnv to `$HOME/.direnvrc`:
## Installation from source ```
source $HOME/.nix-profile/share/nix-direnv/direnvrc
```
You also need to set `keep-outputs` and `keep-derivations` to nix.conf as described in the installation
via home-manager section.
### From source
Clone the repository to some directory Clone the repository to some directory
@ -104,6 +112,9 @@ Then source the direnvrc from this repository in your own `.direnvrc`
source $HOME/nix-direnv/direnvrc source $HOME/nix-direnv/direnvrc
``` ```
You also need to set `keep-outputs` and `keep-derivations` to nix.conf as described in the installation
via home-manager section.
## Usage example ## Usage example
Either add `shell.nix` or a `default.nix` to the same directory: Either add `shell.nix` or a `default.nix` to the same directory: