docs: translate CLAUDE.md to English
Per the committed=English rule.
This commit is contained in:
@@ -1,57 +1,57 @@
|
||||
# Moonset
|
||||
|
||||
## Projekt
|
||||
## Project
|
||||
|
||||
Moonset ist ein Wayland Session Power Menu, gebaut mit Rust + gtk4-rs + gtk4-layer-shell.
|
||||
Teil des Moonarch-Ökosystems. Per Keybind aufrufbares Overlay mit 5 Aktionen:
|
||||
Moonset is a Wayland session power menu, built with Rust + gtk4-rs + gtk4-layer-shell.
|
||||
Part of the Moonarch ecosystem. A keybind-invoked overlay with 5 actions:
|
||||
Lock, Logout, Hibernate, Reboot, Shutdown.
|
||||
|
||||
## Tech-Stack
|
||||
## Tech Stack
|
||||
|
||||
- Rust (Edition 2024), gtk4-rs 0.11, glib 0.22
|
||||
- gtk4-layer-shell 0.8 für Wayland Layer Shell (OVERLAY Layer)
|
||||
- `cargo test` für Unit-Tests
|
||||
- Rust (edition 2024), gtk4-rs 0.11, glib 0.22
|
||||
- gtk4-layer-shell 0.8 for the Wayland Layer Shell (OVERLAY layer)
|
||||
- `cargo test` for unit tests
|
||||
|
||||
## Projektstruktur
|
||||
## Project Structure
|
||||
|
||||
- `src/` — Rust-Quellcode (main.rs, power.rs, i18n.rs, config.rs, users.rs, panel.rs)
|
||||
- `resources/` — GResource-Assets (style.css, default-avatar.svg)
|
||||
- `config/` — Beispiel-Konfigurationsdateien
|
||||
- `src/` — Rust source code (main.rs, power.rs, i18n.rs, config.rs, users.rs, panel.rs)
|
||||
- `resources/` — GResource assets (style.css, default-avatar.svg)
|
||||
- `config/` — example configuration files
|
||||
|
||||
## Kommandos
|
||||
## Commands
|
||||
|
||||
```bash
|
||||
# Tests ausführen
|
||||
# Run tests
|
||||
cargo test
|
||||
|
||||
# Release-Build
|
||||
# Release build
|
||||
cargo build --release
|
||||
|
||||
# Power-Menu starten (in Niri-Session)
|
||||
# Start the power menu (in a Niri session)
|
||||
LD_PRELOAD=/usr/lib/libgtk4-layer-shell.so ./target/release/moonset
|
||||
```
|
||||
|
||||
## Architektur
|
||||
## Architecture
|
||||
|
||||
- `main.rs` — Entry Point, GTK App, Layer Shell Setup, Multi-Monitor, systemd-Journal-Logging, Debug-Level per `MOONSET_DEBUG` Env-Var, zentrale `GRESOURCE_PREFIX`-Konstante
|
||||
- `power.rs` — 5 Power-Action-Wrapper mit absoluten Pfaden und 30s Timeout (lock, logout, hibernate, reboot, shutdown)
|
||||
- `i18n.rs` — Locale-Erkennung und String-Tabellen (DE/EN)
|
||||
- `config.rs` — TOML-Config + Wallpaper-Fallback
|
||||
- `panel.rs` — GTK4 UI (Action-Buttons, Inline-Confirmation, WallpaperWindow)
|
||||
- `users.rs` — User-Erkennung, Avatar-Loading (AccountsService, ~/.face, GResource-Fallback)
|
||||
- `resources/style.css` — GTK-Theme-Colors für Konsistenz mit dem aktiven Desktop-Theme
|
||||
- `main.rs` — entry point, GTK app, Layer Shell setup, multi-monitor, systemd journal logging, debug level via the `MOONSET_DEBUG` env var, central `GRESOURCE_PREFIX` constant
|
||||
- `power.rs` — 5 power-action wrappers with absolute paths and a 30s timeout (lock, logout, hibernate, reboot, shutdown)
|
||||
- `i18n.rs` — locale detection and string tables (DE/EN)
|
||||
- `config.rs` — TOML config + wallpaper fallback
|
||||
- `panel.rs` — GTK4 UI (action buttons, inline confirmation, WallpaperWindow)
|
||||
- `users.rs` — user detection, avatar loading (AccountsService, ~/.face, GResource fallback)
|
||||
- `resources/style.css` — GTK theme colors for consistency with the active desktop theme
|
||||
|
||||
## Design Decisions
|
||||
|
||||
Siehe `DECISIONS.md` für das vollständige Entscheidungsprotokoll.
|
||||
See `DECISIONS.md` for the full decision log.
|
||||
|
||||
Kurzfassung der wichtigsten Entscheidungen:
|
||||
- **OVERLAY statt TOP Layer**: Waybar liegt auf TOP, moonset muss darüber
|
||||
- **Niri-spezifischer Logout** (`niri msg action quit`): Moonarch setzt fest auf Niri
|
||||
- **Einmal-Start per Keybind**: Kein Daemon, GTK `application_id` verhindert Doppelstart
|
||||
- **System-Icons**: Adwaita/Catppuccin liefern alle benötigten symbolischen Icons
|
||||
- **Lock ohne Confirmation**: Lock ist sofort reversibel, braucht kein Confirm
|
||||
- **Absolute Pfade für Binaries**: `/usr/bin/systemctl` etc. statt relativer Pfade (Security)
|
||||
- **GResource-Bundle**: CSS und Default-Avatar sind in die Binary kompiliert (Wallpaper kommt vom Dateisystem)
|
||||
- **Async Power Actions**: `glib::spawn_future_local` + `gio::spawn_blocking` mit 30s Timeout
|
||||
- **Journal-Logging**: `systemd-journal-logger` statt File-Logging — `journalctl -t moonset`, Debug-Level per `MOONSET_DEBUG` Env-Var
|
||||
Summary of the most important decisions:
|
||||
- **OVERLAY instead of TOP layer**: Waybar sits on TOP, moonset must be above it
|
||||
- **Niri-specific logout** (`niri msg action quit`): Moonarch commits firmly to Niri
|
||||
- **Single launch per keybind**: no daemon, the GTK `application_id` prevents double launch
|
||||
- **System icons**: Adwaita/Catppuccin provide all required symbolic icons
|
||||
- **Lock without confirmation**: lock is immediately reversible, needs no confirm
|
||||
- **Absolute paths for binaries**: `/usr/bin/systemctl` etc. instead of relative paths (security)
|
||||
- **GResource bundle**: CSS and default avatar are compiled into the binary (the wallpaper comes from the filesystem)
|
||||
- **Async power actions**: `glib::spawn_future_local` + `gio::spawn_blocking` with a 30s timeout
|
||||
- **Journal logging**: `systemd-journal-logger` instead of file logging — `journalctl -t moonset`, debug level via the `MOONSET_DEBUG` env var
|
||||
|
||||
Reference in New Issue
Block a user