hyprland-void-dots/README.md
2024-02-19 13:01:58 +03:30

96 lines
No EOL
2.2 KiB
Markdown

# Hyprland Configuration and Setup Guide for Void Linux
![Hyprland Logo](assets/hyprland.png)
## Overview
This repository contains instructions and configurations for setting up Hyprland on Void Linux. Hyprland is a powerful Tiling compositor.
## Table of Contents
- [Hyprland Configuration and Setup Guide for Void Linux](#hyprland-configuration-and-setup-guide-for-void-linux)
- [Overview](#overview)
- [Table of Contents](#table-of-contents)
- [Requirements](#requirements)
- [Package Dependencies](#package-dependencies)
- [Installation](#installation)
## Requirements
Ensure that your system meets the following requirements before proceeding:
### Package Dependencies
The following packages are required for the proper functioning of Hyprland on Void Linux:
<details>
<summary><strong>Core Hyprland Components</strong></summary>
- [Void-Hyprland](https://github.com/Makrennel/hyprland-void)
- hyprland
- hyprland-protocols
- xdg-desktop-portal-hyprland
- xdg-desktop-portal
</details>
<details>
<summary><strong>System Components</strong></summary>
- dbus : service
- seatd : service
- elogind : service
- polkit : service
- NetworkManager : service
- gnome-keyring
- polkit-gnome
- [ly](https://github.com/fairyglade/ly) : service
- mesa-dri
- [pipewire](https://docs.voidlinux.org/config/media/pipewire.html)
- wireplumber
- stow
- inotify-tools
</details>
<details>
<summary><strong>User Interface Components</strong></summary>
- Waybar
- swaybg
- animated bg [swww](https://github.com/LGFae/swww)
- swaylock or [swaylock-effects](https://github.com/mortie/swaylock-effects)
- grim
- slurp
- jq
- cliphist
- wl-clipboard
- libnotify
- dunst
- swayidle
- swappy
- rofi
- wlogout
- font-awesome-6
- fontmanager
</details>
## Installation
Follow these steps to install Hyprland on your Void Linux system:
1. Clone this repository:
```bash
git clone https://github.com/hesam-init/.dotfiles.git ~/.dots-hyprland
```
2. Change into the repository directory:
```bash
cd ~/.dots-hyprland
```
3. Run this command to sync hyprland configs:
```bash
stow hyprland
```