diff --git a/README.md b/README.md index 71e5478..7d7633a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,70 @@ -# Arch Hyprland Configuration +# 🐧 Arch Hyprland Configuration -This repository contains my Hyprland configuration files for Arch Linux. +``` + _ _ _ _ _ _ _ ____ _ _ _____ ____ _______ ____ _____ + | | | | \ | | | | | / ___|| | | | ____| _ \| ____| _ \| ____| + | |_| | \| | | | | \___ \| |_| | _| | |_) | _| | |_) | _| + | _ | |\ | | | | ___) | _ | |___| _ <| |___| _ <| |___ + |_| |_|_| \_|_|_|_| |____/|_| |_|_____|_| \_\_____|_| \_\_____| +``` -## Files Included +Welcome to my Arch Linux Hyprland configuration repository! This setup provides a modern, efficient, and highly customizable desktop environment using the Hyprland window manager. -- `hyprland.conf` - Main Hyprland configuration -- `xdg-portal-hyprland` - XDG portal configuration -- `hong-kong-night.jpg` - Background image +## 📁 Files Included -## Setup +- `hyprland.conf` - Main Hyprland configuration with keybindings, workspace settings, and window management +- `xdg-portal-hyprland` - XDG portal configuration for proper application integration +- `hong-kong-night.jpg` - Beautiful background image -1. Clone this repository to your home directory -2. Symlink the configuration files to `~/.config/hypr/` -3. Restart Hyprland to apply changes +## 🚀 Features -## Features +- **Modern Window Management**: Smooth tiling and floating window behavior +- **Custom Keybindings**: Intuitive shortcuts for productivity +- **Dynamic Workspaces**: Flexible workspace management +- **High Performance**: Optimized for speed and efficiency +- **Easy Customization**: Well-documented configuration for easy modification -- Custom keybindings -- Wallpapers and themes -- Window management settings +## 🛠️ Setup Instructions + +1. Clone this repository to your home directory: + ```bash + git clone https://git.biohazardvfx.com/Nicholai/arch-hyprland.git ~/.config/hypr + ``` + +2. Symlink the configuration files to `~/.config/hypr/`: + ```bash + ln -sf ~/.config/hypr/* ~/.config/hypr/ + ``` + +3. Restart Hyprland to apply changes: + ```bash + hyprctl reload + ``` + +## ⚙️ Configuration Details + +### Keybindings +- `Super + Enter` - Open terminal +- `Super + D` - Open application launcher +- `Super + Q` - Close window +- `Super + F` - Toggle fullscreen +- `Super + Shift + E` - Exit Hyprland + +### Workspaces +- Workspaces 1-5 are available +- Switch between workspaces with `Super + [number]` +- Move windows between workspaces with `Super + Shift + [number]` + +## 🎨 Customization + +Feel free to modify the configuration files to suit your preferences. The setup is designed to be easily customizable while maintaining performance and stability. + +## 📝 Notes + +- This configuration assumes you're running Arch Linux with Hyprland +- Make sure to install required dependencies before using +- Contributions and suggestions are welcome! + +--- + +*Made with ❤️ and Hyprland*