From c1d289366b38474bd0a6d7af2dab52bbb8476297 Mon Sep 17 00:00:00 2001 From: phaer Date: Fri, 20 Oct 2023 10:17:32 +0100 Subject: [PATCH] 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. --- docs/quickstart.md | 35 +++++++++++++---------------------- 1 file changed, 13 insertions(+), 22 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 0e391c77..16f46e30 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -32,33 +32,24 @@ below. ## Steps required to run nixos-anywhere -1. **Enable Flakes and Create a Directory**: +1. **Enable Flakes**: - - Ensure that flakes are enabled on your system. To enable flakes, refer to - the [NixOS Wiki](https://nixos.wiki/wiki/Flakes#enable-flakes). - - Create a directory to store the flake and configuration files. + Ensure that flakes are enabled on your system. To enable flakes, refer to the + [NixOS Wiki](https://nixos.wiki/wiki/Flakes#enable-flakes). -2. **Initialize a Flake**: Within the newly-created directory, execute the - command: +2. **Initialize a Flake**: - ```bash - nix flake init - ``` - - This command will generate a `flake.nix` file. Modify this file according to - your requirements. - - - **For a Minimal Setup**:\ - You can copy and paste the example flake contents available - [here](https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix). - This example is tailored for a virtual machine setup similar to one on - [Hetzner Cloud](https://www.hetzner.com/cloud). + The easiest way to start is to copy our + [example flake.nix](https://github.com/numtide/nixos-anywhere-examples/blob/main/flake.nix) + into a new directory. This example is tailored for a virtual machine setup + similar to one on [Hetzner Cloud](https://www.hetzner.com/cloud), so you + might need to adapt it for your setup. - **Hardware-Specific Configuration**: If you're not using a virtual machine, - you'll need to generate a custom hardware configuration with - `nixos-generate-config`. + **Hardware-Specific Configuration**: If you're not using a virtual machine, + you'll need to generate a custom hardware configuration with + `nixos-generate-config`. -- **Getting `nixos-generate-config` on Target Machine**: +- **Get `nixos-generate-config` onto the Target Machine**: 1. **Option 1**: If NixOS is not installed, boot into an installer without first installing NixOS.