Customize for db123: replace configs, adapt installer for dual-GPU/Catppuccin/awww
This commit is contained in:
76
README.md
76
README.md
@@ -1,27 +1,44 @@
|
||||
# Simple Hyprland 🌟
|
||||
Welcome to the Simple Hyprland Guide! This repository is designed to help users set up a minimal Hyprland environment on Arch Linux. Although various scripts and configuration files are available elsewhere, they often result in bloated systems with many unused themes and configurations. This guide aims to provide a clear, concise, and minimal setup, allowing users to understand each step and customize their environment to their liking.
|
||||
# simple-hyprland (db123 fork) 🐱
|
||||
|
||||
By the end of this guide, you'll have a clean and functional Hyprland setup like this:
|
||||
**Personalized fork of [gaurav23b/simple-hyprland](https://github.com/gaurav23b/simple-hyprland) — customized for `db123` (Arch Linux, dual GPU, Catppuccin Mocha).**
|
||||
|
||||
| Component | Value |
|
||||
| ---------- | ---------------------------------------------------------- |
|
||||
| Hostname | `db123` |
|
||||
| OS | Arch Linux (rolling) |
|
||||
| CPU | 12th Gen Intel i3-12100 |
|
||||
| GPU | Intel UHD 730 + AMD Radeon RX 580 |
|
||||
| Monitor | HDMI-A-3, 1920x1080@74.97 |
|
||||
| Keyboard | `us,ir` (Win+Space toggle) |
|
||||
| Theme | Catppuccin Mocha (everything) |
|
||||
| Cursor | Bibata-Modern-Ice |
|
||||
| Compositor | Hyprland + plugins (hyprbars, hyprtrails, dynamic-cursors) |
|
||||
| Wallpaper | awww + mpvpaper |
|
||||
| Shell | fish |
|
||||
|
||||
## Quick Installation
|
||||
|
||||
```bash
|
||||
git clone https://git.db123.ir/db123/simple-hyprland.git ~/simple-hyprland
|
||||
cd ~/simple-hyprland/scripts/installer
|
||||
sudo sh install.sh
|
||||
```
|
||||
|
||||
## Screenshots
|
||||
|
||||
<img src="/assets/github_repo/images/final-setup-01.png" alt="final-setup-01">
|
||||
<img src="/assets/github_repo/images/final-setup-02.png" alt="final-setup-02">
|
||||
|
||||
##### Setup Walkthrough 👇 (Click to Play)
|
||||
[](https://www.youtube.com/watch?v=eNJorbKz_-U)
|
||||
## Credits
|
||||
|
||||
## Purpose ✨
|
||||
This guide is intended for:
|
||||
|
||||
**Newcomers transitioning to Hyprland who want to gain knowledge.** 👋 If you're new to Hyprland and looking to understand the ins and outs of setting it up, this guide will take you through the process step-by-step, explaining each component along the way.
|
||||
|
||||
**Users who wish to set up a minimal system their way, knowing what's happening at each step.** 🧠 Rather than relying on scripts that automate the process, this guide empowers you to build your Hyprland environment from the ground up, enabling you to customize and tweak every aspect according to your preferences.
|
||||
|
||||
**Individuals looking to save time by following a structured and efficient setup process.** ⏱️ While many guides and resources are available, they can be scattered and overwhelming. This guide consolidates the essential steps into a streamlined workflow, helping you get up and running with Hyprland quickly and efficiently.
|
||||
Forked from [gaurav23b/simple-hyprland](https://github.com/gaurav23b/simple-hyprland) — original guide author. Thanks to the [Hyprland project](https://github.com/hyprwm/Hyprland), [hyprdots](https://github.com/prasanthrangan/hyprdots), and the Catppuccin community.
|
||||
|
||||
## Getting Started 🚀
|
||||
|
||||
If you're new to this guide, you can start from the [Prerequisites section](docs/prerequisites.md). This document outlines the necessary tools, packages, and assumptions required for a smooth installation and setup process.
|
||||
|
||||
## Documentation 📚
|
||||
|
||||
1. [Prerequisites](docs/prerequisites.md)
|
||||
2. [Core Installation](docs/installation_Hypr.md)
|
||||
3. [Basic Configuration](docs/basic_configuration.md)
|
||||
@@ -30,22 +47,24 @@ If you're new to this guide, you can start from the [Prerequisites section](docs
|
||||
6. [Summary](docs/final.md)
|
||||
|
||||
## Compatibility ⚙️
|
||||
|
||||
While this guide is created with [Arch Linux](https://archlinux.org/) in mind, it can also be helpful for users of other distributions who are familiar with their package management and system tweaking.
|
||||
|
||||
## Quick Installation Script 🚀
|
||||
|
||||
1. Clone the repository to your home folder:
|
||||
```
|
||||
git clone https://github.com/gaurav23b/simple-hyprland.git ~/simple-hyprland
|
||||
```
|
||||
```
|
||||
git clone https://github.com/gaurav23b/simple-hyprland.git ~/simple-hyprland
|
||||
```
|
||||
2. Navigate to the installer directory:
|
||||
```
|
||||
cd ~/simple-hyprland/scripts/installer
|
||||
```
|
||||
```
|
||||
cd ~/simple-hyprland/scripts/installer
|
||||
```
|
||||
3. Run the installation script with sudo:
|
||||
```
|
||||
sudo sh install.sh
|
||||
```
|
||||
```
|
||||
sudo sh install.sh
|
||||
```
|
||||
|
||||
#### Important Notes:
|
||||
|
||||
- This script is user-centric and allows you to choose which components to install (Everything is asked, even for the core).
|
||||
@@ -55,12 +74,12 @@ While this guide is created with [Arch Linux](https://archlinux.org/) in mind, i
|
||||
|
||||
> **Note for Newcomers**: Although this script enables rapid setup, it's highly recommended to read through the documentation for those new to Hyprland. Understanding each step will greatly enhance your ability to customize and troubleshoot your environment.
|
||||
|
||||
|
||||
### Key Bindings 🎹
|
||||
|
||||
After installation, you'll want to familiarize yourself with the default key bindings. Here are some essential shortcuts to get you started:
|
||||
|
||||
#### General
|
||||
|
||||
- `Super + T`: Open the terminal (`$terminal`).
|
||||
- `Super + B`: Open the browser (`$browser`).
|
||||
- `Super + O`: Open notes application (`$notes`).
|
||||
@@ -71,6 +90,7 @@ After installation, you'll want to familiarize yourself with the default key bin
|
||||
- `Super + M`: Exit Hyprland.
|
||||
|
||||
#### Window Management & Workspace Navigation
|
||||
|
||||
- `Super + Q`: Close the active window.
|
||||
- `Super + W`: Toggle floating mode for the active window.
|
||||
- `Super + J`: Toggle split mode in the Dwindle layout.
|
||||
@@ -81,6 +101,7 @@ After installation, you'll want to familiarize yourself with the default key bin
|
||||
- `SUPER + SHIFT + [1-9]`: Move active window to workspace 1-9
|
||||
|
||||
#### Screen Brightness, Volume and Media Control
|
||||
|
||||
- `Brightness Up`: Increase the screen brightness by 5%.
|
||||
- `Brightness Down`: Decrease the screen brightness by 5%.
|
||||
- `Volume Up`: Increase the volume by 5%.
|
||||
@@ -92,6 +113,7 @@ After installation, you'll want to familiarize yourself with the default key bin
|
||||
- `Previous Track`: Go back to the previous track.
|
||||
|
||||
#### Miscellaneous
|
||||
|
||||
- `Super + V`: Open the clipboard history and paste the selected item.
|
||||
- `Super + P`: Open the color picker and copy the selected color to the clipboard.
|
||||
- `Super + L`: Lock the screen.
|
||||
@@ -104,11 +126,13 @@ After installation, you'll want to familiarize yourself with the default key bin
|
||||
Make sure to have applications installed corresponding to the binds. Feel free to customize these keybindings to better suit your needs. You can customize these and add more in your Hyprland configuration file (`~/.config/hypr/hyprland.conf`).
|
||||
|
||||
## Credits 🙏
|
||||
|
||||
Many configuration parts, themes, and scripts in this guide are sourced from the community. I extend my thanks to all contributors, especially the [Hyprland project](https://github.com/hyprwm/Hyprland) and other cool repositories like [hyprdots](https://github.com/prasanthrangan/hyprdots). If you find that credit has not been given where due, please feel free to open a Pull Request (PR).
|
||||
|
||||
## References 📖
|
||||
* [Hyprland Wiki](https://wiki.hyprland.org/)
|
||||
* [Hyprdots Repo](https://github.com/prasanthrangan/hyprdots)
|
||||
* [Hyprland-titus Repo](https://github.com/ChrisTitusTech/hyprland-titus) and more.
|
||||
|
||||
- [Hyprland Wiki](https://wiki.hyprland.org/)
|
||||
- [Hyprdots Repo](https://github.com/prasanthrangan/hyprdots)
|
||||
- [Hyprland-titus Repo](https://github.com/ChrisTitusTech/hyprland-titus) and more.
|
||||
|
||||
Feel free to explore the documentation and contribute to this guide if you find any improvements or have suggestions. 🤝
|
||||
|
||||
Reference in New Issue
Block a user