Krolyxon
Commit 6fa78da

Branches

Refs →

auroraREADME.md

73 lines · 3.5 KB · Markdown

1# Dotfiles
2
3![Fullscreen](assets/fullscreen.png)
4
5My desktop: **Arch Linux + Hyprland** (Lua config) + **aurora**, a custom Quickshell shell (bar, panel,
6notifications, OSD, dock), themed live from the wallpaper with **pywal16** and deployed with **GNU stow**.
7
8> [!WARNING]
9> **This is my personal setup, not a general purpose dotfiles framework.**
10>
11> It's built around my hardware (Lenovo Legion, Intel + NVIDIA hybrid graphics, `linux-zen`), my monitors,
12> my keyboard and my habits. I'm not trying to make it work for everyone, and I won't be adding options
13> or support for other setups. It's public as a **reference**, or for people who want **exactly the same
14> setup** as me.
15>
16> **Only run `install.sh` on a freshly installed, unconfigured Arch Linux system.** It installs a lot of
17> packages (NVIDIA drivers included if you pick them), replaces your configs with symlinks, changes your login
18> shell and can enable system services. Don't run it on a system you already use.
19
20## Just want a piece of it?
21You don't need the installer for that. Browse the repo and copy what you like, for example:
22- `.config/quickshell/aurora/`: the shell (needs Quickshell; it reads its colours from `~/.cache/wal/colors.json`)
23- `.config/hypr/`: Hyprland in the new Lua config format
24- `.local/bin/`: small scripts (`setwall`, `brictl`, `sysact`, `tms`, ...)
25- `.config/wal/templates/`: pywal16 templates for Hyprland, fuzzel, zathura, cava
26
27## Installing (fresh Arch only)
28```bash
29git clone https://git.krolyxon.com/dotfiles ~/.dotfiles
30cd ~/.dotfiles
31./install.sh # interactive: pick packages per group
32./install.sh --yes # pre-select the default packages, no pickers
33./install.sh --check # only compare installed packages with the lists, changes nothing
34```
35The repo has to live at `~/.dotfiles` (stow links into the parent directory).
36
37What `install.sh` does:
381. Refuses to run as root or on anything other than Arch, and asks for confirmation if the system doesn't
39 look fresh (another desktop's config, or lots of configs this repo doesn't provide).
402. Installs `stow gum git zsh`, shows the disclaimer, then lets you pick packages per group.
413. Runs `stow . --no-folding`. Files that are in the way are **moved** to `~/.dotfiles-backup/<date>/`, not deleted.
424. Sets zsh as your login shell.
435. Installs `paru` if it's missing, then installs the desktop packages and everything you picked.
446. Optionally copies `system/etc/keyd/default.conf` to `/etc/keyd` and enables `keyd` (capslock: tap esc, hold ctrl).
45
46Afterwards, reboot and log in to Hyprland.
47
48## Packages
49The lists live in `packages/*.txt`: one package per line, `#` for comments, and a trailing `!` means
50"listed, but not pre-selected".
51
52| file | |
53|---|---|
54| `desktop.txt` | always installed: Hyprland, Quickshell, PipeWire, the tools the shell and keybinds call |
55| `utils.txt` | CLI tools, fonts, media, small utilities |
56| `dev.txt` | development tools |
57| `gpu.txt` | Intel + NVIDIA (`nvidia-open-dkms`) drivers. Change this for your hardware |
58| `optional.txt` | desktop apps |
59| `aur.txt` | AUR packages (installed with paru) |
60| `base.txt` | reference only, never installed: what the base install already provides |
61
62## What's inside
63| | |
64|---|---|
65| WM | Hyprland (Lua config), hypridle, hyprlock, hyprpaper |
66| Shell / bar | aurora (Quickshell) |
67| Theming | pywal16 (`setwall` picks a wallpaper and re-themes everything) |
68| Terminal / shell | foot, zsh |
69| Editor | Neovim (LazyVim) |
70| Launcher / menus | fuzzel |
71| Files | lf, pcmanfm |
72| Music / video | mpd + ncmpcpp, mpv |
73| Font / icons | JetBrainsMono Nerd Font, Yaru |