doc: Document impure eval in README (#203)
* doc: Document impure eval in README * Use official wiki link Co-authored-by: Jonas Chevalier <zimbatm@zimbatm.com> --------- Co-authored-by: Jonas Chevalier <zimbatm@zimbatm.com>
This commit is contained in:
parent
db89a99a45
commit
2e5bcfaf4a
1 changed files with 13 additions and 4 deletions
17
README.md
17
README.md
|
|
@ -23,9 +23,9 @@ It builds on the many modules that already exist in [NixOS][nixos].
|
||||||
|
|
||||||
[nixos]: https://nixos.org
|
[nixos]: https://nixos.org
|
||||||
|
|
||||||
# Usage
|
## Usage
|
||||||
|
|
||||||
## Getting Nix
|
### Getting Nix
|
||||||
|
|
||||||
In order to use System Manager, you will first need to install Nix.
|
In order to use System Manager, you will first need to install Nix.
|
||||||
You can either use your distro's package manager, or use one of the different options
|
You can either use your distro's package manager, or use one of the different options
|
||||||
|
|
@ -112,12 +112,21 @@ Once the configuration is defined, you can activate it using the `system-manager
|
||||||
nix run 'github:numtide/system-manager' -- switch --flake '.'
|
nix run 'github:numtide/system-manager' -- switch --flake '.'
|
||||||
```
|
```
|
||||||
|
|
||||||
# Currently supported features
|
### Reproducibility
|
||||||
|
|
||||||
|
By design flakes run in [pure evaluation mode](https://wiki.nixos.org/wiki/Flakes#Making_your_evaluations_pure).
|
||||||
|
In some cases you may not want this. To run an impure evaluation of the flake, add the following option to your command:
|
||||||
|
```sh
|
||||||
|
--nix-option pure-eval false
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Currently supported features
|
||||||
|
|
||||||
Currently it is possible to configure files under `/etc/` and systemd services.
|
Currently it is possible to configure files under `/etc/` and systemd services.
|
||||||
More features may follow later.
|
More features may follow later.
|
||||||
|
|
||||||
## Supported Systems
|
### Supported Systems
|
||||||
|
|
||||||
System Manager is currently only supported on NixOS and Ubuntu. However, it can be used on other distributions by enabling the following:
|
System Manager is currently only supported on NixOS and Ubuntu. However, it can be used on other distributions by enabling the following:
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue