README Update

README.md

@@ -1,8 +1,63 @@
-## 🚧 Guide will be written soon 🚧
+<h1 align="center">Nomadics NixOS</h1>
-### tldr: use the the installer after installing nixos
+
+<div align="center">
+<img src="./assets/logo.png" alt="NixOS Logo" width="50"/>
+    </div>
 
 
-#### Layout
+- Hyprland
+- Waybar
+- Wofi
+- Hyprlock + Hypridle
+- Zsh
+- Wayland
+- Nightfox theme
+- Simple <b>GPU - Passthrough</b> Module
+
+## Screenshots
+![Nomadics Nixos](./assets/preview2.png)
+![Nomadics Nixos](./assets/preview3.png)
+![Nomadics Nixos](./assets/preview4.png)
+![Nomadics Nixos](./assets/preview5.png)
+![Nomadics Nixos](./assets/gpu-passthrough.png)
+![Nomadics Nixos](./assets/hyprlock.png)
+
+#### All Keybinds ```SUPER + F1```
+![Nomadics Nixos](./assets/keybinds.png)
+
+
+
+
+## Installation
+1. [Download NixOS](https://nixos.org/download/)
+2. Gnome recommended for graphical installation.
+3. ```git clone https://github.com/nomadics9/nixcfg.git```
+4. ```cd nixcfg```
+5. ```sudo bash install.sh``` and follow the installer.
+
+## Configurations - optional
+For user packages you will find them in ```home/nomad/home.nix```. You can remove all packages here or keep them nothing is dependent on them.
+![Home](./assets/home.png)
+
+#### Nvidia users
+You might want to check ```hosts/unkown/hardware/nvidia.nix``` and change these values accordingly. 
+![Nvidia](./assets/nvidia.png)
+
+#### GPU - Passthrough VM
+You <b>MUST</b> check and configure ```hosts/common/services/vfio.nix``` accordingly its straight forward if you follow the comments.
+
+#### Link your dotfiles from github repo
+Right now the flake is configured to pull dotfiles and scripts from [Here](https://github.com/nomadics9/dotfiles). Fork this repo adjust as you like and change ```flake.nix``` dotfiles url to point to your repo.
+![Nomadics Dotfiles](./assets/dotfiles.png)
+
+
+## Todo
+
+- Add more dotfiles? firefox's for example
+
+<details>
+<summary><h4>Layout</h4></summary>
+
 ```
 nixcfg/
 ├── home/
@@ -54,3 +109,4 @@ nixcfg/
 ├── install.sh
 ├── README.md
 ```
+</details>