Skip to content

Commit c1d2893

Browse files
phaermergify[bot]
authored andcommitted
don't recommend starting from an empty flake...
...as we've received feedback that this is more confusing for newer users than starting from the example and it's probably safe to assume more experienced users will be able to figure it out on their own.
1 parent 3ce8720 commit c1d2893

File tree

1 file changed

+13
-22
lines changed

1 file changed

+13
-22
lines changed

docs/quickstart.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,24 @@ below.
3232

3333
## Steps required to run nixos-anywhere
3434

35-
1. **Enable Flakes and Create a Directory**:
35+
1. **Enable Flakes**:
3636

37-
- Ensure that flakes are enabled on your system. To enable flakes, refer to
38-
the [NixOS Wiki](https://nixos.wiki/wiki/Flakes#enable-flakes).
39-
- Create a directory to store the flake and configuration files.
37+
Ensure that flakes are enabled on your system. To enable flakes, refer to the
38+
[NixOS Wiki](https://nixos.wiki/wiki/Flakes#enable-flakes).
4039

41-
2. **Initialize a Flake**: Within the newly-created directory, execute the
42-
command:
40+
2. **Initialize a Flake**:
4341

44-
```bash
45-
nix flake init
46-
```
47-
48-
This command will generate a `flake.nix` file. Modify this file according to
49-
your requirements.
50-
51-
- **For a Minimal Setup**:\
52-
You can copy and paste the example flake contents available
53-
[here](https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix).
54-
This example is tailored for a virtual machine setup similar to one on
55-
[Hetzner Cloud](https://www.hetzner.com/cloud).
42+
The easiest way to start is to copy our
43+
[example flake.nix](https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix)
44+
into a new directory. This example is tailored for a virtual machine setup
45+
similar to one on [Hetzner Cloud](https://www.hetzner.com/cloud), so you
46+
might need to adapt it for your setup.
5647

57-
**Hardware-Specific Configuration**: If you're not using a virtual machine,
58-
you'll need to generate a custom hardware configuration with
59-
`nixos-generate-config`.
48+
**Hardware-Specific Configuration**: If you're not using a virtual machine,
49+
you'll need to generate a custom hardware configuration with
50+
`nixos-generate-config`.
6051

61-
- **Getting `nixos-generate-config` on Target Machine**:
52+
- **Get `nixos-generate-config` onto the Target Machine**:
6253

6354
1. **Option 1**: If NixOS is not installed, boot into an installer without
6455
first installing NixOS.

0 commit comments

Comments
 (0)