README

README.md

@@ -1,13 +1,29 @@
 # Sakamoto NixOS 
 Sakamoto NixOS is built with various profiles intended for reproducibility.
 
+## Available Hosts
+* MacBook M series
+* Linux
+
 ## Installation
-As of now, it is still under construction. Thus, you can only access `desktop` profile for both `nixosConfiguration` and `homeConfiguration`. Follow the instructions below.
+1. Install [Nix](https://nixos.org/download/).
-
+2. Clone this git repository.
-1. Edit `info.nix` variables. There are various options such as the vpn section that you may need to modify. Otherwise, the program may not work.
+```sh
-2. On the current directory, execute the following command:
+git clone https://git.sakamoto.dev/kenji/nixos.git ~/.config/nixos && cd ~/.config/nixos/
 ```
-$ nixos-rebuild switch --flake ./#desktop
+3. Inside the `~/.config/nixos/` directory, copy `info.default.nix` and rename it to `info.local.nix`.
-$ home-manager switch --flake ./#desktop
+```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 `<PLACEHOLDER>`.**
+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
 ```
 
+