From 954fdce6e0d296ae1b462d3291abcc11ef9afa6e Mon Sep 17 00:00:00 2001
From: hesam-init <hesam.init@gmail.com>
Date: Mon, 12 Feb 2024 12:15:45 +0330
Subject: [PATCH] doc: install guide and required packages

---
 .install/hyprland-packages.sh |   1 +
 README.md                     | 121 ++++++++++++++++++++--------------
 2 files changed, 71 insertions(+), 51 deletions(-)

diff --git a/.install/hyprland-packages.sh b/.install/hyprland-packages.sh
index 73cb9d7..a6289b2 100644
--- a/.install/hyprland-packages.sh
+++ b/.install/hyprland-packages.sh
@@ -21,6 +21,7 @@ packages_list=(
     "pipewire"
     "pipewire-pulse"
     "pipewire-devel"
+    "stow"
     # login display:
     "lightdm"
     "sddm"
diff --git a/README.md b/README.md
index 3a909a4..b26125a 100644
--- a/README.md
+++ b/README.md
@@ -1,68 +1,87 @@
-# Streamline Your Setup with My Dotfiles ✨
+# Hyprland Configuration and Setup Guide for Void Linux
 
-Welcome to my personal dotfiles repository! Harness the power of automation to effortlessly manage your configurations across multiple systems.
+<!-- ![Hyprland Logo](link_to_logo) -->
 
-## What's Inside
+## Overview
 
-This repository contains my carefully crafted configuration files for various tools and applications, including:
+This repository contains instructions and configurations for setting up Hyprland on Void Linux. Hyprland is a powerful Tiling compositor.
 
-- **Shell:** zsh
-- **Terminal:** alacritty
-- **...and more!**
+## 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)
+    - [Core Hyprland Components](#core-hyprland-components)
+    - [System Components](#system-components)
+    - [User Interface Components](#user-interface-components)
+  - [Installation](#installation)
+
+## Requirements
+
+Ensure that your system meets the following requirements before proceeding:
+
+- [List any other general requirements]
+
+### Package Dependencies
+
+The following packages are required for the proper functioning of Hyprland on Void Linux:
+
+### Core Hyprland Components
+- hyprland
+- hyprland-protocols
+- xdg-desktop-portal-hyprland
+- xdg-desktop-portal
+
+### System Components
+- dbus
+- seatd
+- polkit
+- polkit-kde-agent
+- elogind
+- mesa-dri
+- lightdm
+- sddm
+- pipewire
+- pipewire-pulse
+- pipewire-devel
+- stow
+
+### User Interface Components
+- waybar
+- grim
+- slurp
+- dunst
+- swayidle
+- swappy
+- cliphist
+- rofi
+- wlogout
+- font-awesome
+
+Make sure to install these packages using your package manager before setting up Hyprland.
+
+[Note: Adjust the package names based on your Void Linux distribution and adapt the installation process accordingly.]
 
 ## Installation
 
-1. **Clone the Repository:**
+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 ~/.dotfiles
+   git clone https://github.com/hesam-init/.dotfiles.git ~/.dots-hyprland
    ```
 
-2. **Install stow:**
-
-   - **Debian:**
-     ```bash
-     sudo apt install stow
-     ```
-   - **Void Linux:**
-     ```bash
-     sudo xbps-install -Sy install stow
-     ```
-   - **Fedora/Red Hat:**
-     ```bash
-     sudo dnf install stow
-     ```
-   - **macOS (Homebrew):**
-     ```bash
-     brew install stow
-     ```
-
-## Set Up Your Configs
-
-1. **Navigate to repository:**
+2. Change into the repository directory:
 
    ```bash
-   cd ~/.dotfiles
+   cd ~/.dots-hyprland
    ```
 
-2. **Symlink all configurations:**
+3. Run this command to sync hyprland configs:
 
    ```bash
-   stow */
-   ```
-
-   To selectively symlink specific configurations:
-
-   ```bash
-   stow zsh alacritty zellij
-   ```
-
-## Additional Notes
-
-- **Customization:** Feel free to tweak the configurations to match your preferences.
-- **Contributions:** Open to suggestions and improvements!
-- **Dependencies:** Ensure any required dependencies are installed for the tools you use.
-
-## Enjoy a Smoother Workflow!
-
-I hope this repository streamlines your setup and enhances your productivity. Feel free to explore, customize, and share your feedback!
+   stow hyprland
+   ```
\ No newline at end of file