diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 133 |
1 files changed, 40 insertions, 93 deletions
@@ -15,43 +15,33 @@ <div align="center"> <br> - <a href="#-copying--installation--update-instructions-"><kbd> <br> Installation <br> </kbd></a>   - <a href="https://www.youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx"><kbd> <br> Youtube <br> </kbd></a>   + <a href="#-installationupdate-instructions"><kbd> <br> Installation <br> </kbd></a>   <a href="https://github.com/LinuxBeginnings/Hyprland-Dots/wiki"><kbd> <br> Wiki <br> </kbd></a>   - <a href="https://github.com/LinuxBeginnings/Hyprland-Dots/discussions"><kbd> <br> Discussions <br> </kbd></a>   - <a href="https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Keybinds"><kbd> <br> Keybinds <br> </kbd></a>   - <a href="https://discord.gg/RZJgC7KAKm"><kbd> <br> Discord <br> </kbd></a> + <a href="https://www.youtube.com/@LinuxBeginnings"><kbd> <br> Youtube <br> </kbd></a>   + <a href="https://discord.gg/RZJgC7KAKm"><kbd> <br> Discord <br> </kbd></a>   + <a href="https://www.youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx"><kbd> <br> Legacy Jak Videos <br> </kbd></a>   </div><br> <div align="center"> - <br/> </div> <h3 align="center"> <img src="https://github.com/LinuxBeginnings/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" /> - KooL's Hyprland Dotfiles Showcase + KooL's Hyprland Dotfiles Showcase <img src="https://github.com/LinuxBeginnings/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" /> </h3> <div align="center"> - -https://github.com/user-attachments/assets/49bc12b2-abaf-45de-a21c-67aacd9bb872 - + <https://github.com/user-attachments/assets/49bc12b2-abaf-45de-a21c-67aacd9bb872> </div> -### 📹 A video walkthroughs - -- at the bottom - -</details> - --- [](https://git.io/typing-svg) -### 🚩 🏁 Auto Distro-Hyprland install scripts cloning and starting 🇵🇭 +### 🏁 Auto Distro-Hyprland install scripts cloning and starting > [!CAUTION] > If you are using FISH SHELL, DO NOT use this function. Clone the Distro-Hyprland and ran install.sh instead @@ -63,11 +53,11 @@ sh <(curl -L https://raw.githubusercontent.com/LinuxBeginnings/Hyprland-Dots/mai ``` - You can use the above command to automatically clone the `Distro-Hyprland` install scripts -- It will clone the install script and start the `install.sh` 😎 +- It will clone the install script and start the `install.sh` -### 👁️🗨️ My Hyprland install Scripts 👁️🗨️ +### 👁️🗨️ My Hyprland install Scripts -- Automated Hyprland Scripts for Distro of choice which will pull this dotfiles if opted to install these configurations +Automated Hyprland Scripts for Distro of choice which will pull this dotfiles if opted to install these configurations - [Arch-Linux](https://github.com/LinuxBeginnings/Arch-Hyprland) @@ -80,36 +70,35 @@ sh <(curl -L https://raw.githubusercontent.com/LinuxBeginnings/Hyprland-Dots/mai - [NixOS (25.05+)](https://github.com/LinuxBeginnings/NixOS-Hyprland) - [Ubuntu 24.04 LTS](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/tree/24.04) -- [Ubuntu 24.10 (depreciated)](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/tree/24.10) -- [Ubuntu 25.04 (depreciated)](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/tree/25.04) +- [Ubuntu 24.10 (deprecated)](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/tree/24.10) +- [Ubuntu 25.04 (deprecated)](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/tree/25.04) - [Ubuntu 25.10](https://github.com/LinuxBeginnings/Ubuntu-Hyprland/tree/25.10) --- -### 🪧 Attention 🪧 +### 🪧 Attention - This repo does NOT contain or will NOT install any packages. These are only pre-configured-hyprland configs or dotfiles - refer to install scripts what packages needed to install... but at least, Hyprland packages are required - This repo will be pulled by the Distro-Hyprland install scripts above if you opt to download pre-configured dots -### 👀 Screenshots 👀 +### 👀 Screenshots - All screenshots are collected here [Screenshots](https://github.com/LinuxBeginnings/screenshots/tree/main/Hyprland-ScreenShots) -### 📦 Whats new? +### 📦 What's new? - To easily track changes, I will be updating the [CHANGELOGS](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Changelogs) Screenshots will be included if worth mentioning the changes! -> [!NOTE] -> Kindly note that by default, Kools Dots are adjusted / configured for 2k (1440p) display without scaling. - -### 💥 Copying / Installation / Update instructions 💥 +### 💥 Installation/Update instructions - [`MORE INFO HERE`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Install_&_Update) > [!Note] > The auto copy script `copy.sh` will create backups of intended directories to be copied. > However, it's still a good idea to manually backup just incase script fails to backup your configuration. > If you already have a hyprland configuration, uninstall it first, or create a new user, and install it with that user + +> To download from main branch - Clone this repo by using `git`. - Change directory, i.e. `cd Arch-Hyprland` - Make `install.sh` executable `chmod +x ./install.sh` @@ -119,16 +108,14 @@ sh <(curl -L https://raw.githubusercontent.com/LinuxBeginnings/Hyprland-Dots/mai > Note: Ubuntu is exception, it has version specific branches ```bash -git clone --depth=1 https://github.com/LinuxBeginnings/Hyprland-Dots.git -cd Hyprland-Dots +git clone --depth=1 https://github.com/LinuxBeginnings/Hyprland-Dots.git && cd Hyprland-Dots ``` -> to download from Development branch (development and testing) -> Not recommeded for non-testing systems +> To download from Development branch +> Not recommended for non-testing systems ```bash -git clone --depth=1 https://github.com/LinuxBeginnings/Hyprland-Dots.git -b development -cd Hyprland-Dots +git clone --depth=1 https://github.com/LinuxBeginnings/Hyprland-Dots.git -b development && cd Hyprland-Dots ``` - automatic copy/install of pre-configured dots (recommended for updating) @@ -138,95 +125,55 @@ chmod +x copy.sh ./copy.sh ``` -- to copy/install from releases (stable) (note this is 1 version older than in main) - -```bash -chmod +x release.sh -./release.sh -``` - -- UPGRADE.sh function - > [!IMPORTANT] - > You need rsync for it to work - > you should have already up and running KooL's Hyprland before using this function - -```bash -chmod +x upgrade.sh -./upgrade.sh -``` - -## ❗❗❗ DEBIAN AND UBUNTU! - -- Debian 13 - - Now builds Hyprland 0.51.1 from source using the `install.sh` script - - So the current version of Hyprland-Dots is compatible only in those cases. - -- Ubuntu 24.04/25.10 - - We are now using a PPA to get more current versions of Hyprland. - - So the current version of these Dotfiles are compatible if you updated to the PPA based configuration. - -#### ⚠️⚠️⚠️ ATTENTION - BACKUPS CREATED by SCRIPT +#### ⚠️ BACKUPS CREATED by SCRIPT > [!CAUTION] -> `copy.sh`, `release.sh` and even `upgrade.sh` creates a backup! +> `copy.sh` creates a backup! > Kindly investigate manually contents on your `$HOME/.config` > Delete manually any backups which you dont want. #### 🛎️ a small note on wallpapers -- by default, only few wallpapers will be copied (1 each dark and light plus 3 more). You will be offered to download more wallpapers. You can preview/check the additional wallpapers from [`THIS`](https://github.com/LinuxBeginnings/Wallpaper-Bank/tree/main/wallpapers) Link - -#### ⚠️⚠️⚠️ A MUST! after copying / Installing these dots - -- Press `SUPER W` and set a wallpaper. This is also to initiate wallust for waybar, kitty (tty) and rofi themes. -- However, If you use the `copy.sh` or the `release.sh`, there will be a preset initial Wallpaper and you dont have to do this - -- Nvidia Owners. Make sure to edit your `~/.config/hypr/UserConfigs/ENVariables.conf` (highly recommended). +- by default, only few wallpapers will be copied (1 each dark and light plus 3 more). You will be offered to download more wallpapers. You can preview/check the additional wallpapers from this [`LINK`](https://github.com/LinuxBeginnings/Wallpaper-Bank/tree/main/wallpapers) -* NVIDIA users / owners, after installation, check [`THIS`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users) +#### ⚠️ after installing these dots +- NVIDIA Owners. + - After installation, check [`THIS`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/FAQ_NVIDIA) + - Make sure to edit your `~/.config/hypr/UserConfigs/ENVariables.conf` (highly recommended). - If you have already set your own keybinds, monitors, etc.... Just copy over from backup created before log-out or reboot. (recommended) -#### 📖 Known issues and possible solutions - -- check out this page [FAQ](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/FAQ) and [UNSOLVED ISSUES](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Known_Issues) - -#### 🙋 QUESTIONS ?!?! ⁉️ +#### 🙋 QUESTIONS ? - FAQ! Yes you can use these dotfiles to other distro! Just ensure to install proper packages first! If it makes you feel better, I use same config on my Gentoo:) -- QUICK HINT! Click the HINT! Waybar module (note only available in Waybar default and Simple-L [TOP] layout). Can be launched by Keybind `SUPER H` +- QUICK HINT! Click the HINT! Waybar module (only available on some layouts). Also can be launched by keybind `SUPER + H` - More question? click here browse through this [WIKI](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/) -- If you want the old configs, it is collected on my "Archive" repo. See [HERE](https://github.com/LinuxBeginnings/Hyprland-Dots-releases-Archive) #### ⌨ Keybinds -- Keybinds [`CLICK`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Keybinds) +- Keybinds [`HERE`](https://github.com/LinuxBeginnings/Hyprland-Dots/wiki/Keybinds) -#### 🙏 Special request +### ✍️ Contributing - If you have improvements on the dotfiles or configuration, feel free to submit a PR for improvement. - I always welcome improvements as I am also just learning just like you guys! +- Click [`HERE`](https://github.com/LinuxBeginnings/Hyprland-Dots/blob/main/CONTRIBUTING.md) for a guide how to contribute -#### ✍️ Contributing +> Thanks to all who have contributed code, or support on the Discord server. Your efforts are greatly appreciated +### 🔮 Discord Server - Want to contribute? Click [`HERE`](https://github.com/LinuxBeginnings/Hyprland-Dots/blob/main/CONTRIBUTING.md) for a guide how to contribute > Thanks to all who have contributed code, or support on the Discord server. You efforts are greatly appreciated -#### 🤷♂️ TO DO! - -- [ ] Tweak dots - 🚧 in constant progress - -#### 🔮 Discord Server +- kindly join my [Discord](https://discord.gg/RZJgC7KAKm) -- kindly join my [Discord](https://discord.com/invite/kool-tech-world) - -#### 💖 Support +### 💖 Support - a Star on my Github repos would be nice 🌟 - -- Subscribe to my Youtube Channel [YouTube](https://www.youtube.com/@Ja.KooLit) +- Subscribe to my Youtube Channel [YouTube](https://www.youtube.com/@LinuxBeginnings) ## 🫰 Thank you for the stars 🩷 + ### Document translations - Spanish: [Código de Conducta](./i18n/CODE_OF_CONDUCT/CODE_OF_CONDUCT.es.md) · [Guía de mensajes de commit](./i18n/COMMIT_MESSAGE_GUIDELINES/COMMIT_MESSAGE_GUIDELINES.es.md) · [Guía de contribución](./i18n/CONTRIBUTING/CONTRIBUTING.es.md) |