diff --git a/README.md b/README.md index bff8282..afbabde 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,63 @@ -## 🚧 Guide will be written soon 🚧 -### tldr: use the the installer after installing nixos +

Nomadics NixOS

+ +
+NixOS Logo +
-#### Layout +- Hyprland +- Waybar +- Wofi +- Hyprlock + Hypridle +- Zsh +- Wayland +- Nightfox theme +- Simple GPU - Passthrough 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 MUST 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 + +
+

Layout

+ ``` nixcfg/ ├── home/ @@ -54,3 +109,4 @@ nixcfg/ ├── install.sh ├── README.md ``` +
diff --git a/assets/Untitled.png b/assets/Untitled.png new file mode 100644 index 0000000..cd912ee Binary files /dev/null and b/assets/Untitled.png differ diff --git a/assets/dotfiles.png b/assets/dotfiles.png new file mode 100644 index 0000000..ab75716 Binary files /dev/null and b/assets/dotfiles.png differ diff --git a/assets/gpu-passthrough.png b/assets/gpu-passthrough.png new file mode 100644 index 0000000..31fd2e6 Binary files /dev/null and b/assets/gpu-passthrough.png differ diff --git a/assets/home.png b/assets/home.png new file mode 100644 index 0000000..55c7b45 Binary files /dev/null and b/assets/home.png differ diff --git a/assets/hyprlock.png b/assets/hyprlock.png new file mode 100644 index 0000000..1b3830b Binary files /dev/null and b/assets/hyprlock.png differ diff --git a/assets/keybinds.png b/assets/keybinds.png new file mode 100644 index 0000000..37b5cac Binary files /dev/null and b/assets/keybinds.png differ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..461eec6 Binary files /dev/null and b/assets/logo.png differ diff --git a/assets/nvidia.png b/assets/nvidia.png new file mode 100644 index 0000000..3875eb5 Binary files /dev/null and b/assets/nvidia.png differ diff --git a/assets/preview1.png b/assets/preview1.png new file mode 100644 index 0000000..f9e7dc2 Binary files /dev/null and b/assets/preview1.png differ diff --git a/assets/preview2.png b/assets/preview2.png new file mode 100644 index 0000000..bdf082f Binary files /dev/null and b/assets/preview2.png differ diff --git a/assets/preview3.png b/assets/preview3.png new file mode 100644 index 0000000..c09daa1 Binary files /dev/null and b/assets/preview3.png differ diff --git a/assets/preview4.png b/assets/preview4.png new file mode 100644 index 0000000..5dda0c5 Binary files /dev/null and b/assets/preview4.png differ diff --git a/assets/preview5.png b/assets/preview5.png new file mode 100644 index 0000000..2b134b4 Binary files /dev/null and b/assets/preview5.png differ