summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvegabook <thomas.browne@mac.com>2023-11-16 22:21:09 +0000
committerMichael Hoang <enzime@users.noreply.github.com>2023-11-23 10:31:55 +1100
commit319104a1258fa71857aae4956a010f553da0cc9b (patch)
tree5ebe4a0dc777fcb82a44a98c7c0f876eb3bcc320
parente67f2bf515343da378c3f82f098df8ca01bccc5f (diff)
Improve flakes documentation in README
Co-Authored-By: Michael Hoang <enzime@users.noreply.github.com>
-rw-r--r--README.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/README.md b/README.md
index fb3cf6f..d2f17b5 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ nix-darwin is built up around [Nixpkgs](https://github.com/NixOS/nixpkgs), quite
To install nix-darwin, a working installation of [Nix](https://github.com/NixOS/nix#installation) is required.
-> NOTE: Using `darwin-installer` is no longer necessary on flake based systems.
+If you wish to use nix-darwin with flakes, please refer to the [flakes](#flakes) section.
```bash
nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A installer
@@ -69,10 +69,9 @@ Configuration lives in `~/.nixpkgs/darwin-configuration.nix`. Check out
}
```
-## Flakes (experimental)
+## Flakes
-There is also preliminary support for building your configuration using a [flake](https://nixos.wiki/wiki/Flakes). This
-is mostly based on the flake support that was added to NixOS.
+nix-darwin aims for both non-flake and flake configurations to be well supported despite flakes being an experimental feature in Nix.
### Step 1. Creating `flake.nix`
@@ -105,7 +104,7 @@ Add the following to `flake.nix` in the same folder as `configuration.nix`:
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-23.05-darwin";
- nix-darwin.url = "github:LnL7/nix-darwin/master";
+ nix-darwin.url = "github:LnL7/nix-darwin";
nix-darwin.inputs.nixpkgs.follows = "nixpkgs";
};