summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Hoang <enzime@users.noreply.github.com>2024-11-17 02:33:37 +1100
committerMichael Hoang <enzime@users.noreply.github.com>2024-11-21 11:07:47 +1100
commit9a1bea70d5728a19ee0a090dc0bcdeb73f09b7a4 (patch)
tree36ff284dcaf10d881c1c6ab4594e2eab7fef208b /README.md
parent5cc3c00f9b689fa98c524674ddf5a569005e4bd9 (diff)
installer: move creating default configuration to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 6 insertions, 19 deletions
diff --git a/README.md b/README.md
index 3bbaf5c..bfc825e 100644
--- a/README.md
+++ b/README.md
@@ -115,14 +115,18 @@ nix-darwin.lib.darwinSystem {
<details>
<summary>Channels</summary>
-### Installing
+### Step 1. Creating `configuration.nix`
+
+Copy the [simple](./modules/examples/simple.nix) example to `~/.config/nix-darwin/configuration.nix`.
+
+### Step 2. Installing `nix-darwin`
```bash
nix-build https://github.com/LnL7/nix-darwin/archive/master.tar.gz -A installer
./result/bin/darwin-installer
```
-### Updating
+### Step 3. Updating `nix-darwin`
The installer will configure a channel for this repository.
@@ -133,23 +137,6 @@ darwin-rebuild changelog
> NOTE: If you are using Nix as a daemon service the channel for that will be owned by root.
> Use `sudo -i nix-channel --update darwin` instead.
-
-### Example configuration
-
-Configuration lives in `~/.nixpkgs/darwin-configuration.nix`. Check out
-[modules/examples](https://github.com/LnL7/nix-darwin/tree/master/modules/examples) for some example configurations.
-
-```nix
-{ pkgs, ... }:
-{
- # List packages installed in system profile. To search by name, run:
- # $ nix-env -qaP | grep wget
- environment.systemPackages =
- [ pkgs.vim
- ];
-}
-```
-
</details>
## Documentation