Skip to content

Commit e8f5075

Browse files
committed
docs: add package descriptions to README
1 parent ad5c0c2 commit e8f5075

1 file changed

Lines changed: 181 additions & 87 deletions

File tree

README.md

Lines changed: 181 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -284,94 +284,188 @@ Every tool in draphyOS was chosen with a purpose. Here's why:
284284

285285
## 📦 Packages
286286

287+
Every package in draphyOS was chosen for a reason. Here's the complete list with explanations:
288+
289+
<details>
290+
<summary><strong>Fedora i3 Spin — Core (Pre-installed)</strong></summary>
291+
292+
These come with Fedora i3 Spin. draphyOS builds on top of them.
293+
294+
| Package | What it does | Why it's here |
295+
| ------- | ------------ | ------------- |
296+
| `i3` | Tiling window manager | The foundation — lightweight, keyboard-driven, tiling workflow |
297+
| `i3lock` | Screen locker | Security — locks screen with custom draphyOS logo |
298+
| `i3status` | Default status bar | Replaced by polybar, but kept for fallback |
299+
| `dmenu` | Default app launcher | Replaced by rofi, but kept for fallback |
300+
| `dunst` | Notification daemon | Lightweight, keyboard-friendly, highly configurable notifications |
301+
| `lightdm` | Display manager | Login screen — minimal, reliable, easy to theme |
302+
| `alacritty` | Terminal emulator | GPU-accelerated, fast, configurable via TOML |
303+
| `NetworkManager` | Network management | WiFi/Ethernet — auto-connect, easy switching |
304+
| `network-manager-applet` | Network tray icon | Quick network switching from system tray |
305+
| `firefox` | Web browser | Default browser — privacy-respecting, open source |
306+
| `pulseaudio-utils` | Audio tools (`pactl`) | Volume control from keybindings and polybar |
307+
| `pavucontrol` | Volume control GUI | Per-application volume, input/output device selection |
308+
| `brightnessctl` | Brightness control | Laptop screen brightness from keybindings |
309+
| `htop` | Process viewer | Quick system overview, kill processes |
310+
| `mousepad` | Text editor | Simple GUI editor for quick config edits |
311+
| `Thunar` | File manager | Lightweight GUI file manager (GTK-based) |
312+
313+
</details>
314+
315+
<details>
316+
<summary><strong>Fedora i3 Spin — Extended (Pre-installed)</strong></summary>
317+
318+
Additional tools from i3 Spin that draphyOS uses or enhances.
319+
320+
| Package | What it does | Why it's here |
321+
| ------- | ------------ | ------------- |
322+
| `rofi` | App launcher | Beautiful, themeable launcher — replaces dmenu |
323+
| `powertop` | Power analysis | Identify power-hungry processes, optimize battery |
324+
| `arandr` | Display config | Visual multi-monitor setup and arrangement |
325+
| `tmux` | Terminal multiplexer | Split terminal, persistent sessions, remote work |
326+
| `lxappearance` | GTK theme switcher | Change GTK themes, icons, fonts without editing files |
327+
328+
</details>
329+
330+
<details>
331+
<summary><strong>Desktop Environment — draphyOS Additions</strong></summary>
332+
333+
Core packages that make draphyOS look and function the way it does.
334+
335+
| Package | What it does | Why it's here |
336+
| ------- | ------------ | ------------- |
337+
| `polybar` | Status bar | Highly customizable bar — replaces i3status with icons, modules |
338+
| `picom` | Compositor | Window transparency, shadows, blur, rounded corners |
339+
| `fish` | Shell | Modern shell — syntax highlighting, autosuggestions out-of-box |
340+
| `feh` | Image viewer | Sets wallpaper on login, lightweight image viewing |
341+
| `flameshot` | Screenshots | Select area, annotate, blur, save/copy — full-featured screenshots |
342+
| `playerctl` | Media control | Control any media player (Spotify, Firefox, VLC) via keybindings |
343+
| `xss-lock` | Screen lock trigger | Auto-locks screen after idle timeout (15 min) |
344+
| `blueman` | Bluetooth manager | Easy Bluetooth pairing and device management |
345+
| `gammastep` | Blue light filter | Reduces eye strain at night — auto-adjusts by time/location |
346+
| `xfce-polkit` | Auth dialogs | Prompts for password when apps need root (package installs, etc.) |
347+
| `gnome-keyring` | Secret storage | Stores passwords, SSH keys — auto-unlocks on login |
348+
| `xfce4-settings` | Settings manager | Central place for appearance, keyboard, display settings |
349+
| `yad` | Dialog boxes | Powers the calendar popup when clicking date in polybar |
350+
| `qt5ct` | Qt5 theming | Makes Qt apps respect the GTK dark theme |
351+
| `ImageMagick` | Image processing | Creates the logo overlay for the lock screen |
352+
| `xdotool` | X11 automation | Executes keybindings from cheatsheet |
353+
| `xclip` | Clipboard | Copies commands from cheatsheet to clipboard |
354+
355+
</details>
356+
357+
<details>
358+
<summary><strong>Fonts & Theming</strong></summary>
359+
360+
Visual consistency across the entire desktop.
361+
362+
| Package | What it does | Why it's here |
363+
| ------- | ------------ | ------------- |
364+
| `fira-code-fonts` | Programming font | Ligatures (=> becomes arrow), excellent readability |
365+
| `google-noto-sans-mono-vf-fonts` | Fallback mono font | Unicode coverage for characters Fira Code doesn't have |
366+
| `fontawesome-6-free-fonts` | Icon font | All the icons in polybar (volume, wifi, battery, etc.) |
367+
| `fontawesome-6-brands-fonts` | Brand icons | Logos for Spotify, Discord, etc. in polybar |
368+
| `mint-y-icons` | Icon theme | Clean, modern folder/app icons — dark variant |
369+
| `adwaita-cursor-theme` | Cursor theme | System default cursor — works everywhere |
370+
371+
</details>
372+
287373
<details>
288-
<summary><strong>Fedora i3 Spin — Core</strong></summary>
289-
290-
| Package | Description |
291-
| ------------------------ | --------------------------------------- |
292-
| `i3` | Tiling window manager |
293-
| `i3lock` | Screen locker |
294-
| `i3status` | Status bar (replaced by polybar) |
295-
| `dmenu` | Application launcher (replaced by rofi) |
296-
| `dunst` | Notification daemon |
297-
| `lightdm` | Display manager (login screen) |
298-
| `alacritty` | Terminal emulator (GPU-accelerated) |
299-
| `NetworkManager` | Network management |
300-
| `network-manager-applet` | Network tray icon |
301-
| `firefox` | Web browser |
302-
| `pulseaudio-utils` | Audio control |
303-
| `pavucontrol` | Volume control GUI |
304-
| `brightnessctl` | Brightness control |
305-
| `htop` | Process viewer |
306-
| `mousepad` | Text editor |
307-
| `Thunar` | File manager |
308-
309-
</details>
310-
311-
<details>
312-
<summary><strong>Fedora i3 Spin — Extended</strong></summary>
313-
314-
| Package | Description |
315-
| -------------- | --------------------- |
316-
| `rofi` | Application launcher |
317-
| `powertop` | Power management |
318-
| `arandr` | Display configuration |
319-
| `tmux` | Terminal multiplexer |
320-
| `lxappearance` | GTK theme switcher |
321-
322-
</details>
323-
324-
<details>
325-
<summary><strong>draphyOS Additions</strong></summary>
326-
327-
| Package | Description |
328-
| -------------------------------- | ----------------------------------- |
329-
| `polybar` | Status bar (replaces i3status) |
330-
| `picom` | Compositor (transparency, shadows) |
331-
| `fish` | Modern shell with auto-suggestions |
332-
| `feh` | Wallpaper setter, image viewer |
333-
| `flameshot` | Screenshot tool |
334-
| `playerctl` | Media player control |
335-
| `xss-lock` | Automatic screen locker |
336-
| `blueman` | Bluetooth manager |
337-
| `gammastep` | Night light / blue light filter |
338-
| `xfce-polkit` | Authentication dialogs |
339-
| `gnome-keyring` | Password/secret storage |
340-
| `xfce4-settings` | Settings manager |
341-
| `yad` | Calendar popup (click date in bar) |
342-
| `qt5ct` | Qt5 theme configuration |
343-
| `ImageMagick` | Image processing (lock screen logo) |
344-
| `xdotool` | X11 automation (cheatsheet execute) |
345-
| `xclip` | Clipboard (cheatsheet copy) |
346-
| `fira-code-fonts` | Programming font with ligatures |
347-
| `google-noto-sans-mono-vf-fonts` | Fallback mono font |
348-
| `fontawesome-6-free-fonts` | Icon font (polybar icons) |
349-
| `fontawesome-6-brands-fonts` | Icon font (brand logos) |
350-
| `mint-y-icons` | Icon theme |
351-
| `adwaita-cursor-theme` | Cursor theme |
352-
| `yazi` | Terminal file manager |
353-
| `ueberzugpp` | Image preview for yazi |
354-
| `btop` | System monitor |
355-
| `zoxide` | Smarter cd command |
356-
| `mpv` | Video player |
357-
358-
</details>
359-
360-
<details>
361-
<summary><strong>Third-Party Applications (v10)</strong></summary>
362-
363-
| Package | Description |
364-
| ------- | ----------- |
365-
| `brave-browser` | Privacy-focused browser |
366-
| `google-chrome-stable` | Chrome browser |
367-
| `code` | Visual Studio Code |
368-
| `proton-vpn-gnome-desktop` | ProtonVPN client |
369-
| `torbrowser-launcher` | Tor Browser |
370-
| `docker-ce` | Container runtime |
371-
| `postgresql-server` | Database server |
372-
| `obs-studio` | Screen recording |
373-
| `kdenlive` | Video editor |
374-
| `neovim` | Text editor |
374+
<summary><strong>Terminal File Manager — yazi</strong></summary>
375+
376+
Modern terminal file manager with image preview support.
377+
378+
| Package | What it does | Why it's here |
379+
| ------- | ------------ | ------------- |
380+
| `yazi` | File manager | Blazing fast, vim-style navigation, image/PDF preview |
381+
| `ueberzugpp` | Image preview | Displays images in terminal for yazi previews |
382+
| `ffmpegthumbnailer` | Video thumbnails | Generates video thumbnails for yazi preview |
383+
| `poppler-utils` | PDF tools | PDF preview in yazi (pdftotext, pdftoppm) |
384+
| `atool` | Archive helper | Preview archive contents (zip, tar, etc.) in yazi |
385+
386+
</details>
387+
388+
<details>
389+
<summary><strong>CLI Tools</strong></summary>
390+
391+
Command-line utilities that improve daily workflows.
392+
393+
| Package | What it does | Why it's here |
394+
| ------- | ------------ | ------------- |
395+
| `git` | Version control | Foundation for code management, draphyOS updates |
396+
| `btop` | System monitor | Beautiful resource monitor — replaces htop for detailed view |
397+
| `zoxide` | Smart cd | Remembers directories, jump with `z` instead of full path |
398+
| `fd-find` | File finder | Fast, user-friendly alternative to `find` |
399+
| `ripgrep` | Code search | Fast grep replacement — respects .gitignore |
400+
| `fzf` | Fuzzy finder | Interactive search for files, history, anything |
401+
| `jq` | JSON processor | Parse JSON in scripts (used for location detection) |
402+
| `ffmpeg` | Media converter | Video/audio conversion, used by other tools |
403+
| `p7zip` | Archive tool | Extract 7z, zip, rar, and other archive formats |
404+
| `neovim` | Text editor | Modern vim — better defaults, Lua config, plugins |
405+
406+
</details>
407+
408+
<details>
409+
<summary><strong>Media & Documents</strong></summary>
410+
411+
Applications for viewing and creating content.
412+
413+
| Package | What it does | Why it's here |
414+
| ------- | ------------ | ------------- |
415+
| `mpv` | Video player | Minimal, keyboard-driven, plays anything |
416+
| `audacious` | Music player | Lightweight audio player with playlists |
417+
| `zathura` | PDF viewer | Vim-style PDF reader — minimal, fast |
418+
| `zathura-pdf-poppler` | PDF backend | Enables PDF rendering in zathura |
419+
| `obs-studio` | Screen recording | Record screen, stream — industry standard |
420+
| `kdenlive` | Video editor | Full-featured video editing (KDE-based) |
421+
| `libreoffice-calc` | Spreadsheets | Excel-compatible spreadsheet editor |
422+
| `libreoffice-writer` | Documents | Word-compatible document editor |
423+
| `gparted` | Disk utility | Partition disks, format drives — GUI tool |
424+
425+
</details>
426+
427+
<details>
428+
<summary><strong>Browsers & Privacy</strong></summary>
429+
430+
Multiple browser options for different needs.
431+
432+
| Package | What it does | Why it's here |
433+
| ------- | ------------ | ------------- |
434+
| `firefox` | Browser (default) | Privacy-respecting, open source — pre-installed |
435+
| `brave-browser` | Browser | Chromium-based, built-in ad blocker, privacy-focused |
436+
| `google-chrome-stable` | Browser | For sites that require Chrome (some Google services) |
437+
| `torbrowser-launcher` | Tor Browser | Anonymous browsing, access .onion sites |
438+
| `proton-vpn-gnome-desktop` | VPN client | ProtonVPN — Swiss-based, no-logs VPN |
439+
440+
</details>
441+
442+
<details>
443+
<summary><strong>Development Tools</strong></summary>
444+
445+
Everything needed for software development.
446+
447+
| Package | What it does | Why it's here |
448+
| ------- | ------------ | ------------- |
449+
| `code` | VS Code | Most popular code editor — extensions, debugging, Git |
450+
| `docker-ce` | Container runtime | Run isolated containers for dev/deployment |
451+
| `docker-ce-cli` | Docker CLI | Command-line interface for Docker |
452+
| `containerd.io` | Container daemon | Low-level container runtime (Docker dependency) |
453+
| `docker-buildx-plugin` | Build tool | Multi-platform Docker image builds |
454+
| `docker-compose-plugin` | Compose | Define multi-container apps in YAML |
455+
| `postgresql-server` | Database | Relational database — auto-configured with your user |
456+
| `postgresql-contrib` | DB extensions | Additional PostgreSQL modules and utilities |
457+
| `fnm` (via install script) | Node.js manager | Fast Node.js version switching per project |
458+
459+
</details>
460+
461+
<details>
462+
<summary><strong>NVIDIA Support (Optional)</strong></summary>
463+
464+
Auto-detected and installed only if NVIDIA GPU is present.
465+
466+
| Package | What it does | Why it's here |
467+
| ------- | ------------ | ------------- |
468+
| `akmod-nvidia` | NVIDIA driver | Proprietary driver — auto-rebuilds on kernel updates |
375469

376470
</details>
377471

0 commit comments

Comments
 (0)