diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 77 |
1 files changed, 50 insertions, 27 deletions
@@ -42,14 +42,18 @@ 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 🇵🇭 -> [!CAUTION] + +> [!CAUTION] > If you are using FISH SHELL, DO NOT use this function. Clone the Distro-Hyprland and ran install.sh instead - NOTE: you need package `curl` for this to work @@ -61,8 +65,8 @@ sh <(curl -L https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/Distr - you can now use above command to automatically clone the Distro-Hyprland install scripts below - it will clone the install scripts and start the `install.sh` 😎 - ### 👁️🗨️ My Hyprland install Scripts 👁️🗨️ + - Automated Hyprland Scripts for Distro of choice which will pull this dotfiles if opted to install these configurations - [Arch-Linux](https://github.com/JaKooLit/Arch-Hyprland) @@ -77,117 +81,136 @@ sh <(curl -L https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/Distr - [Ubuntu 24.04 LTS](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/24.04) - [Ubuntu 24.10](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/24.10) -- [Ubuntu 25.04 - (ALPHA STAGE)](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/25.04) +- [Ubuntu 25.04](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/25.04) +- [Ubuntu 25.10](https://github.com/JaKooLit/Ubuntu-Hyprland/tree/25.10) + --- ### 🪧 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 atleast, Hyprland packages is needed 😏😏😏 duh!! - This repo will be pulled by the Distro-Hyprland install scripts above if you opt to download pre-configured dots ### 👀 Screenshots 👀 + - All screenshots are collected here [Screenshots](https://github.com/JaKooLit/screenshots/tree/main/Hyprland-ScreenShots) ### 📦 Whats new? -- To easily track changes, I will be updating the [CHANGELOGS](https://github.com/JaKooLit/Hyprland-Dots/wiki/Changelogs) Screenshots will be included if worth mentioning the changes! + +- To easily track changes, I will be updating the [CHANGELOGS](https://github.com/JaKooLit/Hyprland-Dots/wiki/Changelogs) Screenshots will be included if worth mentioning the changes! > [!NOTE] -> Kindly note that by defeault, Kools Dots are adjusted / configured for 2k (1440p) display without scaling. +> Kindly note that by defeault, Kools Dots are adjusted / configured for 2k (1440p) display without scaling. ### 💥 Copying / Installation / Update instructions 💥 -- [`MORE INFO HERE`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Install_&_Update) -> [!Note] -> The auto copy script "copy.sh" will create backups of intended directories to be copied. However, still a good idea to manually backup just incase script failed to backup! + +- [`MORE INFO HERE`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Install_&_Update) + > [!Note] + > The auto copy script "copy.sh" will create backups of intended directories to be copied. However, still a good idea to manually backup just incase script failed to backup! - clone this repo by using git. Change directory, make executable and run the script > to download from Master branch + ```bash git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git cd Hyprland-Dots ``` > to download from Development branch (development and testing) + ```bash git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git -b development cd Hyprland-Dots ``` - automatic copy/install of pre-configured dots (recommended for updating) + ```bash 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 + > [!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 HEADS UP! -- I am getting ridiculously amount of messages for updating your KooL Hyprland dotfiles. I have made a BIG note on [`WIKI`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Install_&_Update) +## ❗❗❗ DEBIAN AND UBUNTU! +- Debian 13 and ubuntu 25.10 +- You can now build Hyprland 0.51.1 from source using the `install.sh` script +- So the current version of Hyprland-Dots is compatible only in those cases. #### ⚠️⚠️⚠️ ATTENTION - BACKUPS CREATED by SCRIPT + > [!CAUTION] > copy.sh, release.sh and even upgrade.sh creates a backup! > Kindly investigate manually contents on your $HOME/.config > Delete manually all the backups which you dont need #### 🛎️ 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/JaKooLit/Wallpaper-Bank/tree/main/wallpapers) Link +#### ⚠️⚠️⚠️ A MUST! after copying / Installing these dots -#### ⚠️⚠️⚠️ 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 +- 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). -- NVIDIA users / owners, after installation, check [`THIS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users) +- Nvidia Owners. 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) +* NVIDIA users / owners, after installation, check [`THIS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users) +- 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/JaKooLit/Hyprland-Dots/wiki/FAQ) and [UNSOLVED ISSUES](https://github.com/JaKooLit/Hyprland-Dots/wiki/Known_Issues) +- check out this page [FAQ](https://github.com/JaKooLit/Hyprland-Dots/wiki/FAQ) and [UNSOLVED ISSUES](https://github.com/JaKooLit/Hyprland-Dots/wiki/Known_Issues) #### 🙋 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` - More question? click here browse through this [WIKI](https://github.com/JaKooLit/Hyprland-Dots/wiki/) - If you want the old configs, it is collected on my "Archive" repo. See [HERE](https://github.com/JaKooLit/Hyprland-Dots-releases-Archive) #### ⌨ Keybinds + - Keybinds [`CLICK`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Keybinds) #### 🙏 Special request -- 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! +- 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! #### ✍️ Contributing -- Want to contribute? Click [`HERE`](https://github.com/JaKooLit/Hyprland-Dots/blob/main/CONTRIBUTING.md) for a guide how to contribute +- Want to contribute? Click [`HERE`](https://github.com/JaKooLit/Hyprland-Dots/blob/main/CONTRIBUTING.md) for a guide how to contribute #### 🤷♂️ TO DO! -- [ ] Tweak dots - 🚧 in constant progress + +- [ ] Tweak dots - 🚧 in constant progress #### 🔮 Discord Server -- kindly join my [Discord](https://discord.com/invite/kool-tech-world) +- kindly join my [Discord](https://discord.com/invite/kool-tech-world) #### 💖 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/@Ja.KooLit) - you can also give support through coffee's or btc 😊 @@ -197,12 +220,12 @@ or [](https://www.buymeacoffee.com/JaKooLit) -Or you can donate cryto on my btc wallet :) +Or you can donate cryto on my btc wallet :) + > 1N3MeV2dsX6gQB42HXU6MF2hAix1mqjo8i  +## 🫰 Thank you for the stars 🩷 - -## 🫰 Thank you for the stars 🩷 [](https://starchart.cc/JaKooLit/Hyprland-Dots) |