Skip to content

Commit f59c44a

Browse files
committed
better disko docs
1 parent 3aca18a commit f59c44a

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

docs/quickstart.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,31 @@ not be able to log into the target machine post-installation without it.
6868

6969
### 4. Configure Storage
7070

71-
In the same directory, create a file named `disk-config.nix`. This will be used
72-
to specify the disk layout to the
71+
In the same directory, create a file called `disk-config.nix`. This file will
72+
define the disk layout for the
7373
[disko](https://github.com/nix-community/disko/blob/master/docs/INDEX.md) tool,
74-
which nixos-anywhere uses to partition, format and mount the disks.
74+
which is used by nixos-anywhere to partition, format, and mount the disks.
7575

76-
For a simple installation you can paste the contents from the example
76+
For a basic installation, you can copy the contents from the example provided
7777
[here](https://github.com/nix-community/nixos-anywhere-examples/blob/main/disk-config.nix).
78-
This configures a standard GPT (GUID Partition Table) partition compatible with
79-
both EFI and BIOS systems, and mounts the disk as `/dev/sda`. If this doesn’t
80-
meet your requirements, choose an example that suits your disk layout from the
78+
This configuration sets up a standard GPT (GUID Partition Table) that is
79+
compatible with both EFI and BIOS systems and mounts the disk as `/dev/sda`. You
80+
may need to adjust `/dev/sda` to match the correct disk on your machine. To
81+
identify the disk, run the `lsblk` command and replace `sda` with the actual
82+
disk name.
83+
84+
For example, on this machine, we would select `nvme0n1` as the disk:
85+
86+
```
87+
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS
88+
nvme0n1 259:0 0 1.8T 0 disk
89+
```
90+
91+
If this setup does not match your requirements, you can choose an example that
92+
better suits your disk layout from the
8193
[disko examples](https://github.com/nix-community/disko/tree/master/example).
82-
For more information about this configuration, refer to the
83-
[disko documentation.](https://github.com/nix-community/disko)
94+
For more detailed information, refer to the
95+
[disko documentation](https://github.com/nix-community/disko).
8496

8597
### 5. Lock your Flake
8698

0 commit comments

Comments
 (0)