diff --git a/docs/installation_Hypr.md b/docs/installation_Hypr.md index 820c29c..bdefdcd 100644 --- a/docs/installation_Hypr.md +++ b/docs/installation_Hypr.md @@ -1,7 +1,7 @@ # Hyprland & Critical Softwares With the prerequisite base system established, we proceed to the core of this guide. This section delineates the process of installing Hyprland and configuring critical system software to ensure a robust and efficient workflow. -### Hyprland Installation +## Hyprland Installation 1. **Install Hyprland:** ``` @@ -29,7 +29,7 @@ To remove the warning: To access web resources, open Kitty and execute `brave-browser` to launch the Brave browser. -### Critical System Components +## Critical System Components 1. **XDG Desktop Portal:** The XDG Desktop Portal is crucial for handling desktop functionalities such as file dialogs and screensharing. ``` @@ -68,7 +68,7 @@ To access web resources, open Kitty and execute `brave-browser` to launch the Br exec-once=/usr/bin/dunst ``` -### Hyprland Session Reload +## Hyprland Session Reload After installing the critical software components and making the necessary configurations, restart your Hyprland session to ensure all new settings and software are properly initialized and integrated. Next: [Basic Configuration](basic_configuration.md) \ No newline at end of file diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 335b164..b97cee3 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -1,10 +1,10 @@ # Prerequisites This guide assumes understanding of Linux systems, particularly [Arch Linux](https://archlinux.org/). The following prerequisites are essential for the seamless installation and setup of Hyprland on your system. -#### Base System +## Base System **Arch Linux:** A minimal Arch Linux Installation is required. It's assumed that you're well-versed with the [Arch installation process]((https://wiki.archlinux.org/title/Installation_guide)) and have a functional base system ready for Hyprland integration. -#### Toolbox Essentials +## Toolbox Essentials 1. **AUR Helper:** An [AUR helper](https://wiki.archlinux.org/title/AUR_helpers) s indispensable for efficient package management from the Arch User Repository. While the choice of helper is discretionary, I'm partial to [yay](https://aur.archlinux.org/packages/yay) for its efficiency and user-friendliness. ``` @@ -61,7 +61,7 @@ This guide assumes understanding of Linux systems, particularly [Arch Linux](htt pacman -S tar ``` -#### Assumed Competencies +## Assumed Competencies * **Basic Linux Command Line Knowledge:** You'll be spending some quality time in the terminal, so make sure you're comfortable with the command line. * **Package Management:** Understanding how to install and manage packages using pacman and an AUR helper is a must. @@ -70,11 +70,11 @@ This guide assumes understanding of Linux systems, particularly [Arch Linux](htt * **Troubleshooting:** Some hiccups may occur along the way, so basic troubleshooting skills will come in handy. -#### Additional Recommendations +## Additional Recommendations * **Backup Your Data:** Ensure you have backups of any important data before embarking on this journey. * **Update Your System:** Keep your system up to date before starting the installation to avoid any potential conflicts. With these prerequisites in place, you're primed to delve into the intricacies of the Simple Hyprland guide and craft a cool, tiling-based environment on your Arch Linux system. -Next: [Core Installation](installation_Hypr.md) \ No newline at end of file +**Next:** [Core Installation](installation_Hypr.md) \ No newline at end of file diff --git a/docs/theming.md b/docs/theming.md index 3e1bf7f..315d24e 100644 --- a/docs/theming.md +++ b/docs/theming.md @@ -1,7 +1,7 @@ # Theming, Look & feel In this guide, we'll transform your Hyprland setup into a visually stunning environment by applying themes to various components. A well-themed desktop not only looks great but also enhances your workflow and overall user experience. -### Installing Essential Tools +## Installing Essential Tools #### nwg-look [nwg-look](https://github.com/nwg-piotr/nwg-look) simplifies the process of setting GTK themes, enabling a cohesive look across different toolkits. @@ -24,7 +24,7 @@ pacman -S qt5ct qt6ct kvantum ##### Adding QT Environment Variables We've already added the necessary QT environment variables during the basic configuration step. -### Installing themes and icons +## Installing themes and icons #### GTK Themes Place the themes in the system theme directory. For this guide, we'll install the [Catppuccin theme](https://github.com/catppuccin/catppuccin) taken from [hyprdots](https://github.com/prasanthrangan/hyprdots) repo, a visually appealing option. @@ -50,7 +50,7 @@ For Arch-based systems, install the kvantum-theme-catppuccin from the AUR: yay -S kvantum-theme-catppuccin ``` -### Setting the Themes +## Setting the Themes 1. Use `nwg-look` to set the global GTK and icon theme, and apply the changes. 2. Open the `kvantummanager` (with sudo to apply as root theme), select the desired theme, and apply it. 3. Open the `qt6ct` (QT6 Settings) and set the icon theme. @@ -58,7 +58,7 @@ yay -S kvantum-theme-catppuccin By default all the configs we used in the previous tutorial are configured with catppuccin color theme. -### Theming applications +## Theming applications At this stage, you might want to theme specific applications to achieve a uniform look across your desktop environment. #### 1. Kitty: The terminal emulator @@ -80,7 +80,7 @@ Copy the configuration file i.e. `dunstrc`. cp ~/Simple-Hyprland/configs/dunst ~/.config/ ``` -### Misc +## Misc Some additional enhancements to elevate the overall feel and experience. #### 1. Adding blur to the windows diff --git a/docs/useful_utilities.md b/docs/useful_utilities.md index ed9425e..a0cf4b9 100644 --- a/docs/useful_utilities.md +++ b/docs/useful_utilities.md @@ -5,7 +5,7 @@ This section guides you through the installation and configuration of essential **Pro Tip:** In your `hyprland.conf`, organize similar configurations together, such as variables, exec-once statements, and keybindings, for better readability and maintainability. -#### 1. Status Bar: Waybar +## Status Bar: Waybar [Waybar](https://github.com/Alexays/Waybar) provides real-time system information at a glance, ensuring you stay informed about your system's status. ##### Installation @@ -40,7 +40,7 @@ Autostart the bar with: exec-once=waybar ``` -#### 2. App Launcher: Tofi +## App Launcher: Tofi [Tofi](https://github.com/philj56/tofi) offers a minimalistic, Wayland-native application launcher for efficient application access. ##### Installation @@ -73,7 +73,7 @@ Define the launcher command and configuration path: $menu = tofi-drun -c ~/.config/tofi/configA --drun-launch=true ``` -#### 3. Clipboard Manager: Cliphist +## Clipboard Manager: Cliphist [Cliphist](https://github.com/sentriz/cliphist) enables you to keep track of your clipboard history, enhancing productivity when working with multiple pieces of information. ##### Installation @@ -100,7 +100,7 @@ exec-once = wl-paste --type text --watch cliphist store exec-once = wl-paste --type image --watch cliphist store ``` -#### 4. Wallpaper: Swww +## Wallpaper: Swww [Swww](https://github.com/LGFae/swww) allows you to set and manage your desktop background, enhancing the visual appeal of your workspace. ##### Installation @@ -133,7 +133,7 @@ You can also set the keybinding to change the wallpaper : bind = SUPER, N, exec, swww img ~/.config/assets/backgrounds/dark-cat-rosewater.png --transition-fps 255 --transition-type outer --transition-duration 0.8 # Change wallpaper ``` -#### 5. Color Picker: Hyprpicker +## Color Picker: Hyprpicker [Hyprpicker](https://github.com/hyprwm/hyprpicker) allows you to select colors directly from your screen, a handy tool for design and development tasks. ##### Installation @@ -153,7 +153,7 @@ $colorPicker = hyprpicker bind = SUPER, P, exec, $colorPicker | wl-copy # Also copies to clipboard ``` -#### 6. Screen Locker: Hyprlock +## Screen Locker: Hyprlock A screen locker secures your computer when you are away, preventing unauthorized access. ##### Installation @@ -178,7 +178,7 @@ Keybinding to lock the desktop: bind = SUPER, L, exec, hyprlock ``` -#### 7. Idle Manager: Hypridle +## Idle Manager: Hypridle [Hypridle](https://github.com/hyprwm/hypridle) automatically locks your screen or takes other actions when your system is idle, enhancing security and power management. ##### Installation @@ -207,7 +207,7 @@ exec-once = hypridle ``` -#### 8. Logout Menu: Wlogout +## Logout Menu: Wlogout [Wlogout](https://github.com/ArtsyMacaw/wlogout) provides a convenient way to log out, restart, or shut down your system. ##### Installation @@ -235,7 +235,7 @@ Keybinding to launch the logout menu: bind = SUPER, ESCAPE, exec, wlogout ``` -#### 9. Taking Screenshots: Grimblast +## Taking Screenshots: Grimblast [Grimblast](https://github.com/hyprwm/contrib/blob/main/grimblast/grimblast.1.scd) is a script that wraps around grim and slurp, providing enhanced functionality for capturing screenshots. ##### Installation