Tsuz-Hypr-Dotfiles/Readme.md
Tsuzura 638e4d15fb
docs: add LICENSE (GPL-3.0) and README.md
- LICENSE: GPL-3.0, standard FSF boilerplate + full license text
- README.md: project overview, stack, status, credit to end-4/dots-hyprland
  as architectural inspiration (not a fork — no code copied)
2026-07-30 22:41:41 -04:00

36 lines
No EOL
1.1 KiB
Markdown

# tsuzura's dotfiles
A personal Hyprland + QuickShell desktop environment for CachyOS, has a learning expreriance
Architecture and ideas inspired by
[end-4/dots-hyprland](https://github.com/end-4/dots-hyprland) (GPL-3.0).
Every line here was written from scratch — this isn't a fork or a copy.
## Status
Actively in progress. Currently building out the QuickShell shell layer
(bar, theming, notifications, etc.) on top of a working Hyprland + NVIDIA
foundation. Not yet ready for general use — expect hardcoded,
machine-specific values (monitor names, NVIDIA env vars) until portability
cleanup happens later.
## Stack
- **OS:** CachyOS (Arch-based)
- **Compositor:** [Hyprland](https://github.com/hyprwm/Hyprland), Lua config API
- **Shell:** [QuickShell](https://quickshell.outfoxxed.me/) (QML)
- **Shell (login):** fish
- **Terminal:** Kitty
- **Dotfiles manager:** [GNU Stow](https://www.gnu.org/software/stow/)
## Structure
Each top-level folder is a Stow package mirroring its path from `~`, e.g.:
```
hypr/.config/hypr/
quickshell/.config/quickshell/
```
## License
[GPL-3.0](./LICENSE). See the [LICENSE](./LICENSE) file for the full text.