Merge pull request #217 from brockar/brockar-readme

fix: improve formatting and clarity in README.md

README.md

@@ -1,7 +1,8 @@
 <div align="center">
 
 # 💌 KooL's Debian-Hyprland Install Script 💌
-#### For Debian 13 Trixie (Testing) and SID (unstable)
+
+#### For Debian 13 (Trixie) and above (testing, SID)
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/JaKooLit/Hyprland-Dots/main/assets/latte.png" width="400" />
@@ -13,7 +14,7 @@
 </div>
 
 <div align="center">
-<br> 
+<br>
   <a href="#-announcement-"><kbd> <br> Read this First <br> </kbd></a>&ensp;&ensp;
   <a href="#-to-use-this-script"><kbd> <br> Installation <br> </kbd></a>&ensp;&ensp;
   <a href="#gallery-and-videos"><kbd> <br> Gallery <br> </kbd></a>&ensp;&ensp;
@@ -42,109 +43,104 @@
 </p>
 
 <h3 align="center">
-	<img src="https://github.com/JaKooLit/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" />
+ <img src="https://github.com/JaKooLit/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" />
-	KooL Hyprland-Dotfiles Showcase 
+ KooL Hyprland-Dotfiles Showcase
-	<img src="https://github.com/JaKooLit/Telegram-Animated-Emojis/blob/main/Activity/Sparkles.webp" alt="Sparkles" width="38" height="38" />
+ <img src="https://github.com/JaKooLit/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>
 
-### NOTE: Ubuntu-Hyprland install script has its own repo now
-- [`Ubuntu-Hyprland LINK`](https://github.com/JaKooLit/Ubuntu-Hyprland)
-
 ### Gallery and Videos
+
 #### 🎥 Feb 2025 Video explanation of installation with preset
+
 - [YOUTUBE-LINK](https://youtu.be/wQ70lo7P6vA?si=_QcbrNKh_Bg0L3wC)
 - [YOUTUBE-Hyprland-Playlist](https://youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx&si=iaNjLulFdsZ6AV-t)
-
+- [AGS overview DEMO](https://youtu.be/zY5SLNPBJTs)
 
 > [!IMPORTANT]
-> install a backup tool like `snapper` or `timeshift`. and Backup your system before installing hyprland using this script (HIGHLY RECOMMENDED).
+> install a backup tool like `snapper` or `timeshift`. and Backup your system before installing hyprland using this script (**HIGHLY RECOMMENDED**).
 
-> [!CAUTION] 
+> [!CAUTION]
 > Download this script on a directory where you have write permissions. ie. HOME. Or any directory within your home directory. Else script will fail
 
-#### ⚠️ Pre-requisites and VERY Important! ### 
+#### ⚠️ Pre-requisites and VERY Important
+
 - Do not run this installer as sudo or as root
 - This Installer requires a user with a priviledge to install packages
-- Needs a Debian 13 Trixie or greater. As it needs a newer wayland packages! I have tried on Stable Debian 12 Bookworm in which, Hyprland wont build.
+- Needs a Debian 13 Trixie or greater. As it needs a newer wayland packages!
-- edit your /etc/apt/sources.list and remove # on lines with deb-src to enable source packaging else will not install properly especially Hyprland
+- edit your `/etc/apt/sources.list` and **remove** `#` on lines with `deb-src` to enable source packaging else will not install properly especially Hyprland
+
 ```bash
 sudo nano /etc/apt/sources.list
 ```
-- delete # on the lines with 'deb-src' 
+
+- delete # on the lines with 'deb-src'
 - ensure to allow to install non-free drivers especially for users with NVIDIA gpus. You can also install non-free drivers if required. Edit install-scripts/nvidia.sh and change the nvidia stuff's if required
 
 ### 🪧🪧🪧 ANNOUNCEMENT 🪧🪧🪧
 
-- 10 OCTOBER 2025 Update!
+[Debian-Hyprland Changelogs](https://github.com/JaKooLit/Debian-Hyprland/blob/main/CHANGELOGS.md)
-- Hyprland-Debian nows builds 0.51.1 from source! 
+
-  - The installer now can be used to install newer releases later 
+- 10 October 2025 Update!
+- Hyprland-Debian nows builds 0.51.1 from source!
+  - The installer now can be used to install newer releases later
   - If you are currently running 0.49, or 0.50, you can upgrade to 0.51.1
-  - You do not have to re-install everything, but re-running `install.sh` works also 
+  - You do not have to re-install everything, but re-running `install.sh` works also
-  - Intstructions are available in English and Spanish 
+  - Instructions are available in English and Spanish
-
-- 25 July 2025 Update!
-- All Hyprland and associated packages set to install using this script are downloaded and built from source (github). However, do note that it is downloaded from each individual releases. You can set versions by editing the scripts located install-scripts directory.
-- These packages are NOT updated automatically. You need to manually update it yourself
-- 
-- This Repo does not contain Hyprland Dots or configs! Pre-configured Dotfiles are on [`Hyprland-Dots`](https://github.com/JaKooLit/Hyprland-Dots/tree/Debian-Dots) . During installation, if you opt to copy pre-configured dots, it will be downloaded from that centralized repo.
-
-- Hyprland-Dots use are constantly evolving / improving. you can check CHANGELOGS here [`Hyprland-Dots-Changelogs`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Changelogs)
-- Since the Hyprland-Dots are evolving, some of the screenshots maybe old
-- the wallpaper offered to be downloaded towards the end is from this [`WALLPAPER-REPO`](https://github.com/JaKooLit/Wallpaper-Bank)
 
 #### ✨  Some notes on this installer / Prerequisites
-- This script is meant to install in Debian Trixie or newer . This script Will NOT work with Bookworm
+
-- If However, decided to try, recommend to install SDDM. Apart from GDM and SDDM, any other Login Manager may not work nor launch Hyprland. However, hyprland can be launched through tty by type Hyprland
+- Recommend to install SDDM. Apart from GDM and SDDM, any other Login Manager may not work nor launch Hyprland. However, hyprland can be launched through tty by type Hyprland
-- 🕯️ network-manager-gnome (nm-applet) has been removed from the packages to install. This is because it is known to restart the networkmanager causing issues in the installation process. After you boot up, inorder to get the network-manager applet, install network-manager-gnome. `sudo apt install network-manager-gnome` See below if your network or wifi became unmanaged after installation
+- 🕯️ network-manager-gnome (nm-applet) *has been removed* from the packages to install. This is because it is known to restart the networkmanager causing issues in the installation process. After you boot up, inorder to get the network-manager applet, install network-manager-gnome. `sudo apt install network-manager-gnome` See below if your network or wifi became unmanaged after installation
-- If you have nvidia, and wanted to use proprietary drivers, uninstall nouveau first (if installed). This script will be installing proprietary nvidia drivers and will not deal with removal of nouveau.
-- NVIDIA users / owners, after installation, check [`THIS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users)
-- NIVIDIA users:  Strongly suggest you visit this site and install current drivers for newer GPUs. [`NVIDIA-Drivers`](https://github.com/mexersus/debian-nvidia-drivers)
- 
-#### ✨ Costumize the packages to be installed
-- inside the install-scripts directory, you can edit 01-hypr-pkgs.sh. Do not edit 00-dependencies.sh unless you know what you are doing. Care though as the Hyprland Dots may not work properly!
 
 ### 🚩 changing login manager to SDDM
+
 - if you really want to change login manager, there are couple of things you need to carry out before running this install script
 - first install sddm. the no-install-recommends is suggested else it will pull lots of plasma depencies.
+
 ```bash
 sudo apt install --no-install-recommends -y sddm
 ```
+
 - then ran `sudo dpkg-reconfigure sddm` choose sddm and then reboot.
 - once reboot done, you can ran the script and choose sddm & sddm theme
 - [LINK](https://www.simplified.guide/ubuntu/switch-to-gdm) for some guide
 
 #### 💫 SDDM and GTK Themes offered
-- If you opted to install SDDM theme, here's the [`LINK`](https://github.com/JaKooLit/simple-sddm-2) which is a modified fork of [`LINK`](https://github.com/Keyitdev/sddm-astronaut-theme)
-- If you opted to install GTK Themes, Icons,  here's the [`LINK`](https://github.com/JaKooLit/GTK-themes-icons). This also includes Bibata Modern Ice cursor.
 
-#### 🔔 NOTICE TO NVIDIA OWNERS ### 
+- If you opted to install SDDM theme, here's the [LINK](https://github.com/JaKooLit/simple-sddm-2) which is a modified fork of [LINK](https://github.com/Keyitdev/sddm-astronaut-theme)
-- by default it is installing the latest and newest nvidia drivers. If you have an older nvidia-gpu (GTX 800 series and older), check out nvidia-debian website [`LINK`](https://wiki.debian.org/NvidiaGraphicsDrivers) and edit nvidia.sh in install-scripts directory to install proper gpu driver
+- If you opted to install GTK Themes, Icons,  here's the [LINK](https://github.com/JaKooLit/GTK-themes-icons). This also includes Bibata Modern Ice cursor.
+
+#### 🔔 NOTICE TO NVIDIA OWNERS ###
+
+- By default it is installing the latest and newest nvidia drivers. If you have an older nvidia-gpu (GTX 800 series and older), check out nvidia-debian website [LINK](https://wiki.debian.org/NvidiaGraphicsDrivers) and edit nvidia.sh in install-scripts directory to install proper gpu driver
+- If you have nvidia, and wanted to use proprietary drivers, uninstall nouveau first (if installed). This script will be installing proprietary nvidia drivers and will not deal with removal of nouveau.
+- NVIDIA users / owners, after installation, check [`THIS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Notes_to_remember#--for-nvidia-gpu-users)
 
 > [!IMPORTANT]
-> If you want to use nouveau driver, Dont select Nvidia in the options. This is because the nvidia installer part, it will blacklist nouveau. Hyprland will still be installed but it will skip blacklisting nouveau.
+> If you wish to use the nouveau driver (installed by default in Debian), be sure to not select "Nvidia" in the installation options.
-
+> If you select this option, the NVIDIA installer part will attempt to blacklist nouveau; while Hyprland will still be installed, it will skip blacklisting nouveau if you don't select the NVIDIA option.
-> [!IMPORTANT]
-> Another important note for nvidia owners
-> If you have nvidia, by default debian is installing nouveau or open-source nvidia driver. If you want to keep the default nvidia driver installed by Debian, Dont select Nvidia in the options.
 
 ## ✨ Auto clone and install
-> [!CAUTION] 
+>
+> [!CAUTION]
 > If you are using FISH SHELL, DO NOT use this function. Clone and run install.sh instead
 
 - you can use this command to automatically clone the installer and ran the script for you
 - NOTE: `curl` package is required before running this command
+
 ```bash
 sh <(curl -L https://raw.githubusercontent.com/JaKooLit/Debian-Hyprland/main/auto-install.sh)
 ```
 
 ## ✨ to use this script
-> clone this repo (latest commit only) by using git. Change directory, make executable and run the script
+clone this repo, change directory, make executable and run the script:
+
 ```bash
 git clone --depth=1 https://github.com/JaKooLit/Debian-Hyprland.git ~/Debian-Hyprland
 cd ~/Debian-Hyprland
@@ -152,30 +148,16 @@ chmod +x install.sh
 ./install.sh
 ```
 
-### 💥 💥  UNINSTALL SCRIPT / Removal of Config Files
-- 11 March 2025, due to popular request, created a guided `uninstall.sh` script. USE this with caution as it may render your system unstable.
-- I will not be responsible if your system breaks
-- The best still to revert to previous state of your system is via timeshift of snapper
-
-#### ✨ for ZSH and OH-MY-ZSH installation
-> installer should auto change your default shell to zsh. However, if it does not, do this
-```bash
-chsh -s $(which zsh)
-zsh
-source ~/.zshrc
-```
-- reboot or logout
-- by default `xiong-chiamiov-plus` theme is installed. You can find more themes from this [`OH-MY-ZSH-THEMES`](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes)
-- to change the theme, edit ~/.zshrc ZSH_THEME="desired theme"
-
 #### ✨ TO DO once installation done and dotfiles copied
-- SUPER H for HINT or click on the waybar HINT! Button 
-- Head over to [`FAQ`](https://github.com/JaKooLit/Hyprland-Dots/wiki/FAQ) and [`TIPS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/TIPS)
 
+- SUPER H for HINT or click on the waybar HINT! Button
+- Head over to [`FAQ`](https://github.com/JaKooLit/Hyprland-Dots/wiki/FAQ) and [`TIPS`](https://github.com/JaKooLit/Hyprland-Dots/wiki/TIPS)
+- Head over to [KooL Hyprland WIKI](https://github.com/JaKooLit/Hyprland-Dots/wiki)
 
 - if you installed in your laptop and Brightness and Keyboard brightness does not work you can execute this command `sudo chmod +s $(which brightnessctl)`
 
 #### ✨ Packages that are manually downloaded and build. These packages will not be updated by apt and have to be manually updated
+
 - Asus ROG asusctl [`LINK`](https://gitlab.com/asus-linux/asusctl) and superfxctl [`LINK`](https://gitlab.com/asus-linux/supergfxctl)
 - swww [`LINK`](https://github.com/Horus645/swww)
 - hyprlock [`LINK`](https://github.com/hyprwm/hyprlock) #22 Aug 2024 - still not on repo
@@ -186,55 +168,58 @@ source ~/.zshrc
 > [!TIP]
 > To update to latest packages, re-running this script will auto update all. Script is configured to pull latest packages build for you.
 
-#### 🤬 FAQ
+### 💥   UNINSTALL SCRIPT / Removal of Config Files
-#### Most common question I got is, Hey Ja, Why the heck it is taking long time to install? Other distro like Arch its only a minute or two. Why here takes like forever?!?!?!
+
-- Well, most of the core packages are downloaded and Build and compiled from SOURCE. Unlike Other distros, they already have prepacked binary that can just download and install.
+- 11 March 2025, due to popular request, created a guided `uninstall.sh` script. USE this with caution as it may render your system unstable.
+- I will not be responsible if your system breaks
+- The best still to revert to previous state of your system is via **timeshift or snapper**
+
+#### 🤬 FAQ
+
+**Most common question I got is, Hey Ja, Why the heck it is taking long time to install? Other distro like Arch its only a minute or two. Why here takes like forever?!?!?**
+
+- Well, most of the core packages are downloaded and Build and compiled from *SOURCE*. Unlike Other distros, they already have prepacked binary that can just download and install.
+
+## 🛎 ***DEBIAN Hyprland Dots UPDATING NOTES***
 
-## 🛎 *** DEBIAN Hyprland Dots UPDATING NOTES ***
-> [!CHANGE]
 - With this new update to Debian-Hyprland the current Hyprland-Dots are now compatible with Debian. This applies only to Debian, not ubuntu.  
 
-> [!NOTE] 
+> [!NOTE]
 > This script does not setup audio. Kindly set up. If you have not, I recommend pipewire. `sudo apt install -y pipewire`
 
-#### 🎞️ AGS Overview DEMO
-- in case you wonder, here is a short demo of AGS overview [Youtube LINK](https://youtu.be/zY5SLNPBJTs)
-
-#### ✨ TO DO once installation done and dotfiles copied
-- SUPER H for HINT or click on the waybar HINT! Button 
-- Head over to [KooL Hyprland WIKI](https://github.com/JaKooLit/Hyprland-Dots/wiki)
-
 #### 🙋 Got a questions regarding the Hyprland Dots or configurations? 🙋
-- Head over to wiki Link [`WIKI`](https://github.com/JaKooLit/Hyprland-Dots/wiki)
+
+Head over to wiki Link [`WIKI`](https://github.com/JaKooLit/Hyprland-Dots/wiki)
 
 #### ⌨ Keybinds
-- Keybinds [`CLICK`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Keybinds)
+
+Keybinds [`CLICK`](https://github.com/JaKooLit/Hyprland-Dots/wiki/Keybinds)
 
 > [!TIP]
 > KooL Hyprland has a searchable keybind function via rofi. (SUPER SHIFT K) or right click the `HINTS` waybar button
 
-#### 🙋 👋 Having issues or questions? 
+#### 🙋 👋 Having issues or questions?
+
 - for the install part, kindly open issue on this repo
 - for the Pre-configured Hyprland dots / configuration, submit issue [`here`](https://github.com/JaKooLit/Hyprland-Dots/issues)
 
 #### 🔧 Proper way to re-installing a particular script from install-scripts directory
-- CD into Debian-Hyprland DIrectory and then ran the below command. 
+
+- CD into Debian-Hyprland directory and then ran the below command.
 - i.e. `./install-scripts/gtk-themes.sh` - to reinstall GTK Themes or
 - `./install-scripts/sddm.sh` - to reinstall sddm
+
 > [!IMPORTANT]
 > DO NOT CD into install-scripts directory as script as it will fail. Scripts are designed to ran outside install-scripts directory for installation logging purposes.
 
-#### 🎞️ AGS Overview DEMO
+#### 🛣️ Roadmap
-- in case you wonder, here is a short demo of AGS overview [Youtube LINK](https://youtu.be/zY5SLNPBJTs)
 
-#### 🛣️ Roadmap:
 - [ ] possibly adding gruvbox themes, cursors, icons
 
-### ⁉️ KNOWN ISSUE
-- [ ] hypridle wont build (Feb 2025)
-
 #### ❗ some known issues for nvidia
-- reports from members of my discord, states that some users of nvidia are getting stuck on sddm login. credit  to @Kenni Fix stated was 
+
+- reports from members of my discord, states that some users of nvidia are getting stuck on sddm login. credit  to @Kenni Fix stated was
+
 ```  
  while in sddm press ctrl+alt+F2 or F3
 log into your account
@@ -243,33 +228,38 @@ log into your account
 `ls -l /dev/dri/by-path` to check where the symlink points to 
 )
 ```
+
 - add "env = WLR_DRM_DEVICES,/dev/dri/cardX" to the ENVvariables config `~/.config/hypr/UserConfigs/ENVariables.conf`  ; X being where the symlink of the gpu points to
 
 - more info from the hyprland wiki [`Hyprland Wiki Link`](https://wiki.hyprland.org/FAQ/#my-external-monitor-is-blank--doesnt-render--receives-no-signal-laptop)
 
-
 - reports from a member of discord for Nvidia for additional env's
-- remove # from the following env's on 
+- remove # from the following env's on
+
 ```
 env = GBM_BACKEND,nvidia-drm
 env = WLR_RENDERER_ALLOW_SOFTWARE,1
 ```
 
 #### 🫥 Improving performance for Older Nvidia Cards using driver 470
-  - [`SEE HERE`](https://github.com/JaKooLit/Hyprland-Dots/discussions/123#discussion-6035205)
+
+- [`SEE HERE`](https://github.com/JaKooLit/Hyprland-Dots/discussions/123#discussion-6035205)
   
 #### ❗ other known issues
 
 > [!NOTE]
 > Auto start of Hyprland after login (no SDDM or GDM or any login managers)
-- This was disabled a few days ago. (19 May 2024). This was because some users, after they used the Distro-Hyprland scripts with other DE (gnome-wayland or plasma-wayland), if they choose to login into gnome-wayland for example, Hyprland is starting. 
+
+- This was disabled a few days ago. (19 May 2024). This was because some users, after they used the Distro-Hyprland scripts with other DE (gnome-wayland or plasma-wayland), if they choose to login into gnome-wayland for example, Hyprland is starting.
 - to avoid this, I disabled it. You can re-enable again by editing `~/.zprofile` . Remove all the # on the first lines
-- [ ] ROFI issues (scaling, unexplained scaling etc). This is most likely to experience if you are installing on a system where rofi is currently installed. To fix it uninstall rofi and install rofi-wayland . `sudo apt autoremove rofi` . 
+- [ ] ROFI issues (scaling, unexplained scaling etc). This is most likely to experience if you are installing on a system where rofi is currently installed. To fix it uninstall rofi and install rofi-wayland . `sudo apt autoremove rofi` .
-- Install rofi-wayland with 
+- Install rofi-wayland with
+
 ```bash
 cd ~/Debian-Hyprland
 ./install-scripts/rofi-wayland.sh
 ```
+
 - [ ] Rofi-wayland is compatible with x11 so no need to worry.
 
 - [ ] Does not work in Debian Bookworm
@@ -277,26 +267,27 @@ cd ~/Debian-Hyprland
 - [ ] Installing SDDM if or any other Login Manager installed. See [`Issue 2 - SDDM`](https://github.com/JaKooLit/Debian-Hyprland/issues/2)
 - [ ] network is down or become unmanaged [`This`](https://askubuntu.com/questions/71159/network-manager-says-device-not-managed) might help
 
-
 #### 📒 Final Notes
+
 - join my discord channel [`Discord`](https://discord.com/invite/kool-tech-world)
 - Feel free to copy, re-distribute, and use this script however you want. Would appreciate if you give me some loves by crediting my work :)
 
-
 #### ✍️ Contributing
+
 - As stated above, these script does not contain actual config files. These are only the installer of packages
 - If you want to contribute and/or test the Hyprland-Dotfiles (development branch), [`Hyprland-Dots-Development`](https://github.com/JaKooLit/Hyprland-Dots/tree/development)
 - Want to contribute on KooL-Hyprland-Dots Click [`HERE`](https://github.com/JaKooLit/Hyprland-Dots/blob/main/CONTRIBUTING.md) for a guide how to contribute
 - Want to contribute on This Installer? Click [`HERE`](https://github.com/JaKooLit/Debian-Hyprland/blob/main/CONTRIBUTING.md) for a guide how to contribute
 
-#### 👍👍👍 Thanks and Credits!
+#### 👍👍👍 Thanks and Credits
+
 - [`Hyprland`](https://hyprland.org/) Of course to Hyprland and @vaxerski for this awesome Dynamic Tiling Manager.
 
-
 ### 💖 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 😊
 
@@ -311,14 +302,10 @@ Or you can donate cryto on my btc wallet :)
 
 ![Bitcoin](https://github.com/user-attachments/assets/7ed32f8f-c499-46f0-a53c-3f6fbd343699)
 
-
-
 #### 📹 Youtube videos (Click to view and watch the playlist) 📹
+
 [![Youtube Playlist Thumbnail](https://raw.githubusercontent.com/JaKooLit/screenshots/main/Youtube.png)](https://youtube.com/playlist?list=PLDtGd5Fw5_GjXCznR0BzCJJDIQSZJRbxx&si=iaNjLulFdsZ6AV-t)
 
-
-                        
 ## 🥰🥰 💖💖 👍👍👍
-[![Stargazers over time](https://starchart.cc/JaKooLit/Debian-Hyprland.svg?variant=adaptive)](https://starchart.cc/JaKooLit/Debian-Hyprland)
 
-                    
+[![Stargazers over time](https://starchart.cc/JaKooLit/Debian-Hyprland.svg?variant=adaptive)](https://starchart.cc/JaKooLit/Debian-Hyprland)