docs: document terminal-look module in README

This commit is contained in:
edemilov committed 2026-08-30 17:30:18 +03:00
1 parent 5a0629468b
commit efd3a0e754
1 file changed
+48 -17
+48 -17
View File
@@ -1,10 +1,9 @@
# dotevo
A one-command installer for Hyprland + DankMaterialShell (DMS) on any
Arch-based Linux (plain Arch, CachyOS, Manjaro, EndeavourOS, or anything else
with `pacman`). Installs the desktop shell itself unconditionally, then lets
you pick which extra apps you want via an interactive menu -- no fixed bundle
of KDE tools you didn't ask for.
A one-command installer for popular Linux desktop and terminal configurations.
Currently includes **Hyprland rice** (Hyprland + DankMaterialShell) and
**Terminal look** (zsh with Powerlevel10k or Kali-style prompt) — more modules
coming later.
## Install
@@ -16,16 +15,16 @@ bash -c "$(curl -fsSL https://git.edemilov.ru/edemilov/dotevo/raw/branch/master/
substitution, not bash's `<(...)` process substitution, which fish doesn't
support.)
## What's always installed
Hyprland, DankMaterialShell (panel bar + dock + app launcher), the scrolling
(niri-style) window layout, workspace/window keybinds, and a fix for a
common secret-service hang (`ksecretd`).
## What you pick
A `whiptail` menu walks you through:
A `whiptail` menu walks you through component selection first, then
module-specific options:
**Top-level component checklist** (space to toggle, enter to confirm):
- **Hyprland** -- Desktop rice (Hyprland + DankMaterialShell + keybinds) *(on by default)*
- **TerminalLook** -- zsh + prompt style (Powerlevel10k or Kali) *(off by default)*
If you pick **Hyprland**, you'll then choose:
- **Terminal** -- Konsole / Terminator / Kitty / Alacritty (pick one, becomes your `$terminal` default)
- **File manager** -- Dolphin / Nautilus / Thunar (pick one)
- **Mail client** -- Thunderbird / KMail (pick one)
@@ -34,10 +33,20 @@ A `whiptail` menu walks you through:
- **Screen capture** -- grim/slurp/satty/wf-recorder behind one Print-key menu (yes/no)
- **Bitwarden** (yes/no)
If you pick **TerminalLook**, you'll choose:
- **Powerlevel10k** -- Recreates your current zsh setup
- **Kali-style** -- Fresh box-drawing prompt
Want a second terminal or a different mail client later? Install it manually
afterward -- the picker is single-choice per slot on purpose.
## What it does NOT do
## Hyprland rice
The Hyprland-rice module installs Hyprland, DankMaterialShell (panel bar + dock + app launcher), the scrolling
(niri-style) window layout, workspace/window keybinds, and a fix for a
common secret-service hang (`ksecretd`).
### What it does NOT do
- Doesn't touch an existing desktop environment -- Hyprland installs as an
additional login session, nothing else is removed or reconfigured.
@@ -45,7 +54,7 @@ afterward -- the picker is single-choice per slot on purpose.
- Doesn't overwrite your existing configs without backing them up first
(`~/.config/old2026_1/dotevo-backup-<timestamp>/`).
## Keybind cheat-sheet
### Keybind cheat-sheet
| Keys | Action |
|---|---|
@@ -67,8 +76,30 @@ afterward -- the picker is single-choice per slot on purpose.
| `Super + mouse drag` (left/right button) | Move/resize window |
| `Print` | Capture menu (screenshot/record) -- only if Screen capture was picked |
## Terminal look
The Terminal-look module sets up zsh with your chosen prompt style:
- **Powerlevel10k** -- Recreates your current setup: Oh My Zsh + Powerlevel10k theme + standard plugins (git, fzf, zsh-autosuggestions, zsh-syntax-highlighting, zsh-history-substring-search) + `.p10k.zsh` config + fzf integration. The theme renders your prompt with git branch/status icons and a right-side return code.
- **Kali-style** -- A fresh alternative: zsh with Kali Linux's box-drawing prompt style + core plugins (zsh-autosuggestions, zsh-syntax-highlighting, zsh-history-substring-search) + fzf integration. No Oh My Zsh or complex theme framework, just a simple box prompt and essentials.
Both looks install the terminal prerequisites (zsh, git, curl, fzf) across Arch, Debian, Fedora, and openSUSE via their native package managers.
### What it does NOT do
- Doesn't touch an existing shell config without backing it up first
(`~/.config/old2026_1/dotevo-backup-<timestamp>/`).
- Doesn't add any CLI tools beyond the prompt framework and plugins
(zsh, git, curl, fzf, and the theme/prompt files themselves).
- Doesn't change your shell (`chsh`) unless you confirm the interactive prompt.
## Customize
Re-run the installer to change your picks (it rebuilds `~/.config/hypr/extras.conf`
fresh each time). For anything more specific, edit `~/.config/hypr/hyprland.conf`
or `~/.config/hypr/extras.conf` directly afterward.
Re-run the installer to change your picks. For the Hyprland-rice module,
it rebuilds `~/.config/hypr/extras.conf` fresh each time. For the Terminal-look
module, it re-runs the setup and updates your `.zshrc` and prompt config.
For anything more specific:
- Hyprland: edit `~/.config/hypr/hyprland.conf` or `~/.config/hypr/extras.conf` directly
- Terminal: modify your `.zshrc` or `~/.p10k.zsh` (Powerlevel10k) / `~/.dotevo/kali-prompt.zsh` (Kali)