docs: add README.md

README.md

@@ -0,0 +1,91 @@
+# 🚀 NixOS With Hyprland
+
+---
+
+## ✨ Main Applications
+
+- [X] Hyprland (uwsm support)
+- [X] Neovim
+  - ✅ [lazyvim](https://github.com/LazyVim/LazyVim)
+  - ✅ [treesitter](https://github.com/nvim-treesitter/nvim-treesitter)
+  - ❌ mason (not support on NixOS)
+- [X] Waybar
+- [X] Swayidle
+- [X] Swaync (Notification Center)
+- [X] Hyprpaper (Wallpaper)
+- [X] Ghostty (Terminal)
+- [X] SDDM (Display Manager)
+- [X] Fish (shell)
+- [X] Lofi (Application Launcher)
+
+## 🎈 Theme
+
+- Catppuccin (Macchiato Lavender)
+- plymouth (Boot Splash)
+
+## 🎮️ Game
+
+- Steam
+- Xbox wireless controller
+
+## 🧠 Virtualization
+
+- Virt Manager (libvirt)
+- Windows 11 example config: [win11_kvm.xml](./home/config/vm/win11_kvm.xml)
+
+## ⌨️  Input (Fcitx5)
+
+- Rime (bopomofo, pinyin)
+- Mozc (Japanese)
+
+## 🌐 VPN
+
+- Wireguard (You need put your own `wg0.conf` file)
+
+---
+
+## 💿️ Installation
+
+> Your need to add your own device [flake.nix](./flake.nix), and create configuration in [system/dev](./system/dev/) (don't forget the `hardware-configuration.nix` generated with `nixos-generate-config`)
+
+### Example
+
+```
+system/dev/
+├── <your-device-name>
+    ├── boot.nix # You can add extra boot options here 
+    ├── default.nix # Import modules you need
+    └── hardware-configuration.nix # Your hardware configuration
+```
+
+`flake.nix`
+
+```nix
+nixosConfigurations = {
+  <your-device-name> = nixpkgs.lib.nixosSystem {
+    modules = [
+      nix-index-database.nixosModules.nix-index
+      ./system/dev/<your-device-name>
+    ];
+    specialArgs = {
+      inherit inputs system nix-version;
+    };
+  };
+};
+```
+
+### ❄️ Flake
+
+> home manager is configured to rebuild with NixOS
+
+OS Install
+
+```bash
+nixos-install --flake .#<your device name>
+```
+
+Rebuild Switch
+
+```bash
+nixos-rebuild switch --flake .#<your device name>
+```