diff --git a/README.md b/README.md index 9f36401..ae092ab 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ [//]: # (Title: Nixy) [//]: # (Description: Nixy is a Hyprland NixOS configuration with home-manager, secrets and custom theming all in one place. It's a simple way to manage your system configuration and dotfiles.) [//]: # (Author: Hadi) -[//]: # (Date: 08/28/24) -[//]: # (Version: v2.2.0) +[//]: # (Date: 09/04/24) +[//]: # (Version: v2.3.0)
@@ -15,7 +15,7 @@
- + @@ -40,27 +40,41 @@ It's a simple way to manage your system configuration and dotfiles. - [Table of Content](#table-of-content) - [Gallery](#gallery) - [Architecture](#architecture) + - [🏠 `home`](#-home) + - [💻 `hosts`](#-hosts) - [Installation](#installation) - [Documentation](#documentation) ## Gallery -![catppuccin1](docs/src/catppuccin/1.png) -![catppuccin2](docs/src/catppuccin/2.png) -![catppuccin3](docs/src/catppuccin/3.png) +![nixy1](docs/src/nixy/1.png) +![nixy2](docs/src/nixy/2.png) +![nixy3](docs/src/nixy/3.png) ## Architecture -- 🏠 `home` are the dotfiles and configuration files for the users - - 'programs' is a collection of apps configured with home-manager - - 'scripts' is a folder full of bash scripts (see [SCRIPTS.md](docs/SCRIPTS.md)) - - 'system' is some "desktop environment" configuration - - 'wallpapers' are... wallpapers -- 💻 `hosts` are the system configuration files - - 'laptop' is my configuration for my laptop with Nvidia that you can copy - - 'server' is for my homeserver (w/nextcloud, nginx, vaultwarden, ... look `hosts/server`) - - 'themes' contains all the *themes* available *(see [THEMES.md](docs/THEMES.md))* - - 'modules' are some nix modules that you can import (Nvidia, prime, fonts, ...) +### 🏠 `home` + +Those are the dotfiles and configuration files for user-level configuration + +**Subfolders:** + +- `programs` is a collection of apps configured with home-manager +- `scripts` is a folder full of bash scripts (see [SCRIPTS.md](docs/SCRIPTS.md)) +- `system` is some "desktop environment" configuration +- `wallpapers` are... wallpapers + +### 💻 `hosts` + +Those are the host-specific configurations +Each host contains a `configuration.nix` for system-level configuration, a `home.nix` for user-level configuration, and a `variables.nix` for config wide variables. + +**Subfolders:** + +- 🎨 `themes` are the themes available *(see [THEMES.md](docs/THEMES.md))* +- 📦 `modules` are the nix modules that you can import +- `laptop` is my configuration for my laptop with Nvidia that you can copy +- `server` is for my homeserver (w/nextcloud, nginx, vaultwarden, ...) ## Installation diff --git a/docs/KEYBINDINGS.md b/docs/KEYBINDINGS.md index 057ae98..740a0ec 100644 --- a/docs/KEYBINDINGS.md +++ b/docs/KEYBINDINGS.md @@ -2,39 +2,41 @@ The list of the keybindings working on Hyprland: -| Description | Keybinding | -|-----------------------------|--------------------------| -| Switch Workspace | SUPER + {Number} | -| Move app to Workspace | SHIFT + SUPER + {Number} | -| Kitty | SUPER + RETURN | -| Thunar | SUPER + E | -| Qutebrowser | SUPER + B | -| Bitwarden | SUPER + K | -| Peaclock | SUPER + C | -| Lock | SUPER + L | -| Powermenu | SUPER + X | -| Launcher | SUPER + SPACE | -| Close window | SUPER + Q | -| Toggle Floating | SUPER + T | -| Toggle Fullscreen | SUPER + F | -| Move focus left | SUPER + left | -| Move focus Right | SUPER + right | -| Move focus Up | SUPER + up | -| Move focus Down | SUPER + down | -| Add to master | SHIFT + SUPER + left | -| Remove from master | SHIFT + SUPER + right | -| Screenshot window | SUPER + PRINT | -| Screenshot monitor | PRINT | -| Screenshot region | SHIFT + SUPER + PRINT | -| Screenshot region then edit | ALT PRINT | -| Turn off night shift | SUPER + F2 | -| Turn on night shift | SUPER + F3 | -| Choose sound output | SUPER + F5 | -| Move Window (mouse) | SUPER + mouse:272 | -| Resize Window (mouse) | SUPER + R | -| Toggle Mute | XF86AudioMute | -| Lock when closing Lid | switch:Lid Switch | -| Sound Up | XF86AudioRaiseVolume | -| Sound Down | XF86AudioLowerVolume | -| Brightness Up | XF86MonBrightnessUp | -| Brightness Down | XF86MonBrightnessDown | +| Description | Keybinding | +|--------------------------------------------|--------------------------| +| Switch Workspace | SUPER + {Number} | +| Move app to Workspace | SHIFT + SUPER + {Number} | +| Kitty | SUPER + RETURN | +| Thunar | SUPER + E | +| Qutebrowser | SUPER + B | +| Bitwarden | SUPER + K | +| Lock | SUPER + L | +| Powermenu | SUPER + X | +| Launcher | SUPER + SPACE | +| "\$shiftMod, SPACE, hyprexpo:expo, toggle" | | +| Close window | SUPER + Q | +| Toggle Floating | SUPER + T | +| Toggle Fullscreen | SUPER + F | +| Move focus left | SUPER + left | +| Move focus Right | SUPER + right | +| Move focus Up | SUPER + up | +| Move focus Down | SUPER + down | +| Add to master | SHIFT + SUPER + left | +| Remove from master | SHIFT + SUPER + right | +| Screenshot window | SUPER + PRINT | +| Screenshot monitor | PRINT | +| Screenshot region | SHIFT + SUPER + PRINT | +| Screenshot region then edit | ALT PRINT | +| Search on internet with wofi | SHIFT + SUPER + S | +| Clipboard picker with wofi | SHIFT + SUPER + C | +| Emoji picker with wofi | SHIFT + SUPER + E | +| Turn off night shift | SUPER + F2 | +| Turn on night shift | SUPER + F3 | +| Move Window (mouse) | SUPER + mouse:272 | +| Resize Window (mouse) | SUPER + R | +| Toggle Mute | XF86AudioMute | +| Lock when closing Lid | switch:Lid Switch | +| Sound Up | XF86AudioRaiseVolume | +| Sound Down | XF86AudioLowerVolume | +| Brightness Up | XF86MonBrightnessUp | +| Brightness Down | XF86MonBrightnessDown |