diff options
| author | Martin Guzman <55927935+brockar@users.noreply.github.com> | 2026-01-21 16:18:43 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-21 16:18:43 -0300 |
| commit | c6198c1bedeffd08ec3f60f7ba3a41e6c5870885 (patch) | |
| tree | 458c030873b4e70ff9eda0baed5df257434871f4 /README.md | |
| parent | 7dedbe3d4a4560ac15987fdf8164dbbb1f4701bf (diff) | |
| parent | 88a09344e8cc7cffe69a017eb752e8c6fa17ddcb (diff) | |
Merge pull request #927 from JaKooLit/development
Merge Development to main branch for release
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 26 insertions, 11 deletions
@@ -62,8 +62,8 @@ https://github.com/user-attachments/assets/49bc12b2-abaf-45de-a21c-67aacd9bb872 sh <(curl -L https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/Distro-Hyprland.sh) ``` -- 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` 😎 +- 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` 😎 ### 👁️🗨️ My Hyprland install Scripts 👁️🗨️ @@ -101,16 +101,23 @@ sh <(curl -L https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/Distr - 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 default, 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! -- clone this repo by using git. Change directory, make executable and run the script + > 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 + +- Clone this repo by using `git`. +- Change directory, i.e. `cd Arch-Hyprland` +- Make `install.sh` executable `chmod +x ./install.sh` +- Run the script `./install.sh` -> to download from Master branch +> To download from Master branch +> Note: Ubuntu is exception, it has version specific branches ```bash git clone --depth=1 https://github.com/JaKooLit/Hyprland-Dots.git @@ -162,9 +169,9 @@ chmod +x upgrade.sh #### ⚠️⚠️⚠️ 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 +> `copy.sh`, `release.sh` and even `upgrade.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 @@ -172,7 +179,8 @@ chmod +x upgrade.sh #### ⚠️⚠️⚠️ 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). @@ -197,11 +205,13 @@ chmod +x upgrade.sh #### 🙏 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 +> Thanks to all who have contributed code, or support on the Discord server. You efforts are greatly appreciated #### 🤷♂️ TO DO! @@ -234,3 +244,8 @@ Or you can donate cryto on my btc wallet :) ## 🫰 Thank you for the stars 🩷 [](https://starchart.cc/JaKooLit/Hyprland-Dots) + + +### Document translations + +- Spanish: [Código de Conducta](./CODE_OF_CONDUCT.es.md) · [Guía de mensajes de commit](./COMMIT_MESSAGE_GUIDELINES.es.md) · [Guía de contribución](./CONTRIBUTING.es.md) |
