From fd68515eb28b22511543a394aaeb1d9f0bc80e25 Mon Sep 17 00:00:00 2001 From: "thatonecoder (formerly Coccocoa's Helper)" <157546848+Coccocoahelper@users.noreply.github.com> Date: Sun, 8 Feb 2026 15:41:02 +0000 Subject: [PATCH] Attempt to cleanup the README This will still take lots of work, hence why it remains as a draft. --- README.md | 137 ++++++++++++++++++++++-------------------------------- 1 file changed, 55 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index ad36757a..f34987ac 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,6 @@ ## If you need help with installation or troubleshooting, join the Discord server. - -[Join Discord Server][discord] - -[discord]: https://discord.gg/Nv2a7yTBQS +[Join the Discord Server](https://discord.gg/Nv2a7yTBQS) ## Updated demo video now out on YouTube with all major features covered! (since the release of this video around 5 major features have been added, scroll down to the `overview` section for details) @@ -16,10 +13,10 @@ [images]: https://github.com/dusklinux/images -### to get this out of the way cuz i'm getting so many questions about waybar. -YES YOU CAN HAVE HORIZONTAL WAYBAR. and you will be asked which side you want it on bottom/top/left/right. +### Horizontal Waybar?? +Yes, you can have horizontal waybar; you will be asked which side (bottom/top, left/right) you want waybar on, during the setup. -- **waybar horizontal and vertical,:** Take your pick during setup, easily toggleable from rofi as well. +- **waybar horizontal and vertical,:** Take your pick during setup, easily togglable from rofi as well. here's what it looks like. ![New Nerdy Horizontal Waybar](Pictures/readme_assets/waybar_horizontal.webp) @@ -35,18 +32,18 @@ here's what it looks like. ![Dusky Control Center](Pictures/readme_assets/dusky_control_center.webp) -This repository is the result of 8 months of tinkering/breaking/fixing and polishing. Its a labor of love designed to feel as easy to install as a "standard" distribution but with the raw power and minimalism of arch. **please consider starring ⭐ this repo** as a token of support. +This repository is the result of 8 months of tinkering/breaking/fixing and polishing. It's a labor of love designed to feel as easy to install as a "standard" distribution but with the raw power and minimalism of arch. **Please consider starring ⭐ this repo** as a token of support. ## ⚠️ Prerequisites & Hardware ### Filesystem -This setup is strictly optimized for **BTRFS file system format**. (should also work on ext4 but not recommanded) +This setup is strictly optimized for the **BTRFS file system**. It should also work on ext4, but it's not recommended to do so. -- **Why?** ZSTD compression, copy on write (CoW) to prevent data corruption, and you also get instant Snapshots. +- **Why?** zstd compression, copy on write (CoW) to prevent data corruption, and you also get instant Snapshots. -### Hardware Config (Intel/Nvidia/AMD) +### Hardware Config (Intel/NVIDIA/AMD) The setup scripts are written to auto detect your hardware and set the appropriate environment variables but in case your hardware is not detected or has some issues, you're advised to configure the following files to set your environment variables. @@ -65,49 +62,34 @@ The setup scripts are written to auto detect your hardware and set the appropria - Compatible with Windows or other Linux distros. - **Bootloader:** Defaults to `systemd-boot` for UEFI (boots up to 5s faster). Defaults to `GRUB` for BIOS. - - - # Installation 💿 -[Watch Video Tutorial][Watch Video Tutorial] - -[Watch Video Tutorial]: https://youtu.be/OzeFAY_8T8Y +[Watch Video Tutorial](https://youtu.be/OzeFAY_8T8Y) **Best for:** Users who already have a fresh, unconfigured Arch Linux installation with Hyprland, set up either via the archinstall script or through a manual install. If you have not installed yet, use the Arch ISO and ensure you select Btrfs as the filesystem and Hyprland as the window manager. -after installing arch, boot into the os and then run this in the terminal. +After installing Arch, boot into the OS, then run this in the terminal. ### Step 1: Clone Dotfiles (Bare Repo Method) -i use a bare git repository method to drop files exactly where they belong in your home directory. - -make sure your connected to the internet and git is installed, +I use a bare git repository method to drop files exactly where they belong in your home directory. -``` -sudo pacman -Syu --needed git -``` +Do the following commands: +Make sure your connected to the internet and git is installed, -clone the repo -``` -git clone --bare --depth 1 https://github.com/dusklinux/dusky.git $HOME/dusky -``` - -deploy the files on your system. - -```bash -git --git-dir=$HOME/dusky/ --work-tree=$HOME checkout -f -``` +- ``sudo pacman -Syu --needed git``, to make sure you're connected to the internet, and Git's installed +- ``git clone --bare --depth 1 https://github.com/dusklinux/dusky.git $HOME/dusky``, to clone the repository +- ``git --git-dir=$HOME/dusky/ --work-tree=$HOME checkout -f``, to deploy the files on your system > Note: > -> This will immediately list a few errors at the top, but dont worry, that's expected behaviour, the errors will later go away on there own after matugen generates colors and cycles through a wallpaper. +> This will immediately list a few errors at the top. However, do not worry, the errors will later go away on their own, after matugen generates colors and cycles through a wallpaper. ### Step 2: Run the Orchestra -Run the master script to install dependencies, themes, and services, this will take a while. because it sets up everything. You'll be promted to say yes/no during setup, so dont leave it running unattended. +Run the master script to install dependencies, themes, and services. This will take a while, because it sets up everything. You'll be prompted to say yes/no during setup, so don't leave it running unattended. ```bash ~/user_scripts/arch_setup_scripts/ORCHESTRA.sh @@ -119,22 +101,19 @@ The `ORCHESTRA.sh` is a "conductor" that manages ~80 subscripts. - **Smart:** It detects installed packages and skips them. -- **Safe:** You can re-run it as many times as you like without breaking things. +- **Safe:** You can rerun it as many times as you like without breaking things. - **Time:** Expect 30–60 minutes. We use `paru` to install a few AUR packages, and compiling from source takes time. Grab a coffee! - ## ⌨️ Usage & Keybinds The steepest learning curve will be the keybinds. I have designed them to be intuitive, but feel free to change them in the config. > 💡 Pro Tip: > -> Press CTRL + SHIFT + SPACE to open the Keybinds Cheatsheet. You can click commands in this menu to run them directly! - - -It's been tested to work on other arch based distors with hyprland installed (fresh installed) like catchyOS +> Press CTRL + SHIFT + SPACE to open the Keybinds Cheat sheet. You can click commands in this menu to run them directly! +It's been tested to work on other Arch-based distros with hyprland installed (fresh installed), such as CachyOS. ## 🔧 Troubleshooting @@ -147,39 +126,40 @@ If a script fails (which can happen on a rolling release distro): 3. **Run Manually.** You can try running that specific subscript individually. 4. **AI Help.** Copy the script content and the error message into ChatGPT/Gemini. It can usually pinpoint the exact issue (missing dependency, changed package name, etc.). - -## overview +## Overview -Note : i've purposely decided to not use quickshell for anything in the interest of keeping this as light weight as possible, Quickshell can quickly add to ram and slow down your system, therefore everything is user friendly Tui to keep it snappy and lightweight while delivering on A WHOLE HOST OF FEATURES. Read below for most features. +> Note: +> +> I've purposely decided to not use quickshell for anything in the interest of keeping this as light weight as possible, Quickshell can quickly add to ram and slow down your system. Therefore, everything is in user-friendly TUI to keep it snappy and lightweight while delivering on A WHOLE HOST OF FEATURES. Read below for most features. -**utilities** +**Utilities:** -- Music Recognition - allows you to look up what music is playing. +- **Music Recognition**: Allows you to look up what music is playing. -- Circle to search type feature. uses Google lens. +- **Circle to search type.** Uses Google lens. -- Tui for chaining your hyprland's appearience like gaps, shadow color, blur strength, opacity strength and a lottt more!! +- TUI for chaining your hyprland's appearance like gaps, shadow color, blur strength, opacity strength and a lottt more!! -- Ai llm local infrense using ollama side bar (terminal, incredilby resource efficient) +- AI LLM local inference usingOllamaa side bar (terminal,incrediblyy resource efficient) - keybind TUI setter that auto checks for conflicts and unbinds any existing keybind in the default hyrland keybind.conf - Easily switch Swaync's side to either lift or right. -- airmon wifi script for wifi testing/password cracking - (only use on access points that you own, i'm not legally responsible if you use it for nefarious purposes) -- live disk i/o monitoring, to allow you to see live read/write disk speed during copying and infer if copying has actually finsihed, useful for flashdrives, external drives. +- airmon Wi-Fi script for Wi-Fi testing/password cracking + (only use on access points that you own, I'm not legally responsible if you use it for nefarious purposes) +- Live disk I/O monitoring, allowing you to see live read/write disk speed during copying (and infer if copying has actually finished), useful for flashdrives and external drives. -- quick audio input/output switch with a keybind, eg if you have bluetooth headphones connected, you can quicly switch to speakers without disconnecting. +- quick audio input/output switch with a keybind, eg if you have bluetooth headphones connected, you can quickly switch to speakers without disconnecting. -- mono/sterio audio toggling. +- **mono/sterio audio toggling.** - also supports touchpad gestures for volume/brightess, locking the screen, invoking swaync, pause/play, muting.(requires a laptop or a touchpad for pc) - battery notifier for laptops, you can customize it to show notifications at certain levels. -- Togglable power saver mode. +- **Togglable power saver mode.** - system clean up (cache purge)- removes unwanted files to reclaim storage. @@ -189,7 +169,7 @@ Note : i've purposely decided to not use quickshell for anything in the interest - Tailscale auto setup. -- Openssh auto setup. with or without tailscale. +- OpenSSL auto setup. with or without tailscale. - auto warp- cloudflaire setup and toggleale right from rofi. @@ -212,54 +192,51 @@ Note : i've purposely decided to not use quickshell for anything in the interest - github repo integration so you can easily create your own repo to backup all files, this uses bare repo so your specific existing files, listed in ~/.git_dusky_list will backup to github, you can add more files/remove existing ones from this text file. -- btrfs system compression ratio - scans your os files to see how much space zstd compression is saving you. +- **btrfs system compression ratio:** Scans your os files to see how much space zstd compression is saving you. - drive manager, easily lock/unlock encrypted drives from the terminal using "unlock media or lock media", it automaticlaly mounts your drives at a specified path, also unmounts when you lock it. This requires you to first configure the ~/user_scripts/drives/drive_manager.sh script with your drives' uuid. - ntfs drives have a tendency to not unlock if the drive had previously been disconnected without unmounting first, because of corrupted metadata, i've a script that fixes this. ntfs_fix.sh -RoFI menus. +**rofi Menus:** - Emoji - Calculator -- Matugen Theme switcher. -- Animation switcher. +- Matugen Theme switcher +- Animation switcher - Power menu. - Clipboard - Wallpaper selector -- Shader menu. -- System menu. +- Shader menu +- System menu +- ...and a lot more! -and a lot more that would take forever to list, trust me these dotfiles are the shit! try em out. +**GUI keybind invokable sliders:** -GUI keybind invokable sliders for: - Volume control - Brightness control - Nightlight/hyprsunset intensity. -Speech to text -- Whisper - for cpu +**Speech to text:** +- **Whisper:** for CPU or -- Parakeet - for nvidia gpus. might also work on Amd (not sure) +- **Parakeet:** for NVIDIA GPUs (maybe also AMD's). -text to speech +**Text to speech:** - kokoro for both cpu and gpu -- mechanical keypress sounds -togglalble with a keybind or from rofi. +Mechanical keypress sounds toggleable with a keybind, or from rofi. +Wlogout is drawn using a dynamic script that respects your frational scaling. -- Wlogout is drawn using a dynamic script that respects your frational scaling. +**Performance and system** -**performance and system** - -- **light weight**, ~900MB RAM usage and ~5GB disk usage (fully configured). +- **Lightweight:** ~900MB RAM usage and ~5GB disk usage (fully configured). - **ZSTD & ZRAM:** Compression enabled by default to save storage and triple your effective RAM (great for low-spec machines). - **Native Optimization:** AUR helpers configured to build with CPU-native flags (up to 20% performance boost). - - **UWSM Environment:** Optimized specifically for Hyprland. @@ -284,8 +261,6 @@ togglalble with a keybind or from rofi. - **Accessibility:** Text-to-Speech (TTS) and Speech-to-Text (STT) capabilities (hardware dependent). - **Keybind Cheatsheet:** Press `CTRL` + `SHIFT` + `SPACE` anytime to see your controls. - -
@@ -295,10 +270,8 @@ If you run into issues, check the detailed Obsidian notes included in the repo (
- - -# Acknowledgments: -Thank you to all the Contributors! +# Acknowledgments +Thank you to all the contributors! sddm is a modified version of the SilentSDDM project by @uiriansan (this is a great project! Kindly star it on github)