README revamp

2025-05-21 17:54:27 -05:00
parent 752a6ad1de
commit 4f0c6d3e46
1 changed files with 12 additions and 1 deletions
@@ -1,2 +1,13 @@
-# NixOS configuration
+# Sakamoto NixOS 
+Sakamoto NixOS is built with various profiles intended for reproducibility.
+
+## 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. 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.
+2. On the current directory, execute the following command:
+```
+$ nixos-rebuild switch --flake ./#desktop
+$ home-manager switch --flake ./#desktop
+```