diff --git a/README.md b/README.md index 27f5b34..670c89f 100644 --- a/README.md +++ b/README.md @@ -7,23 +7,33 @@ Sakamoto NixOS is built with various profiles intended for reproducibility. ## Installation 1. Install [Nix](https://nixos.org/download/). -2. Clone this git repository. +2. Ensure nix is installed properly by running `nix-shell -p nano`. +3. Clone the git repository. ```sh git clone https://git.sakamoto.dev/kenji/nixos.git ~/.config/nixos && cd ~/.config/nixos/ ``` -3. Inside the `~/.config/nixos/` directory, copy `info.default.nix` and rename it to `info.local.nix`. -```sh -cp ~/.config/nixos/info.default.nix ~/.config/nixos/info.local.nix -``` -🚨 **CRITICAL STEP:** Edit `info.local.nix` to your suitable needs, especially your **username!**. Failure to do so may lock you out of your system. **If you accidentally created the `biscuit` user, you will need to enter that username and its password on next login. The password is ``.** -4. Execute the following command based on your host: -* MacBook M series: -```sh -sudo nix run nix-darwin --extra-experimental-features "nix-command flakes" -- switch --flake ~/.config/nixos#macos -``` -* Linux: -```sh -sudo nixos-rebuild --extra-experimental-features "nix-command flakes" -- switch --flake ~/.config/nixos#desktop -``` +4. Copy `info.default.nix` and rename it to `info.local.nix`: + + ```sh + cp ~/.config/nixos/info.default.nix ~/.config/nixos/info.local.nix + ``` + + 🚨 **CRITICAL STEP:** Edit `info.local.nix` by executing `nano ~/.config/nixos/info.local.nix` to your suitable needs, especially your **username**. + Failure to do so may lock you out of your system. + **If you accidentally created the `biscuit` user, you will need to enter that username and its password on next login. The password is ``.** + +5. Execute the following command based on your host: + + - **MacBook M series:** + + ```sh + sudo nix run nix-darwin --extra-experimental-features "nix-command flakes" -- switch --flake ~/.config/nixos#macos + ``` + + - **Linux:** + + ```sh + sudo nixos-rebuild --extra-experimental-features "nix-command flakes" -- switch --flake ~/.config/nixos#desktop + ```