From 30f2178b6f2a6a05dc3f257c6280136f2d374b53 Mon Sep 17 00:00:00 2001 From: lsoriano-mcm Date: Fri, 6 Jun 2025 20:25:13 -0500 Subject: [PATCH] RE --- README.md | 51 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 670c89f..d868089 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,27 @@ -# Sakamoto NixOS +# Sakamoto NixOS + Sakamoto NixOS is built with various profiles intended for reproducibility. ## Available Hosts -* MacBook M series -* Linux + +- MacBook M series +- Linux ## Installation + 1. Install [Nix](https://nixos.org/download/). -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/ -``` + +2. Ensure Nix is installed properly by running the following (this also gives you `nano` for editing later): + + ```sh + nix-shell -p nano + ``` + +3. Clone the git repository: + + ```sh + git clone https://git.sakamoto.dev/kenji/nixos.git ~/.config/nixos && cd ~/.config/nixos/ + ``` 4. Copy `info.default.nix` and rename it to `info.local.nix`: @@ -19,21 +29,26 @@ git clone https://git.sakamoto.dev/kenji/nixos.git ~/.config/nixos && cd ~/.conf 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 ``.** + 🚨 **CRITICAL STEP:** Edit `info.local.nix`: + + ```sh + nano ~/.config/nixos/info.local.nix + ``` + + Modify it to fit your system — especially your **username**. + If you accidentally leave the default `biscuit`, that user will be created. + **Login password for `biscuit` 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 - ``` + ```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 - ``` - + ```sh + sudo nixos-rebuild --extra-experimental-features "nix-command flakes" -- switch --flake ~/.config/nixos#desktop + ```