docs: translate README to English
This commit is contained in:
137
README.md
137
README.md
@@ -14,90 +14,91 @@ cd LazyUpdateManager
|
|||||||
./install.sh
|
./install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
That's it. After installation you have:
|
After installation:
|
||||||
|
|
||||||
| Was? | Befehl |
|
| Command | Action |
|
||||||
|------|--------|
|
|---------|--------|
|
||||||
| Desktop-App starten | `lazy-update-manager gui` (oder aus Wofi/Rofi starten) |
|
| `lazy-update-manager gui` | Open the desktop app (or launch from app menu) |
|
||||||
| Nur Web-UI | `lazy-update-manager gui web` |
|
| `lazy-update-manager gui web` | Open the web UI in your browser |
|
||||||
| Updates prüfen | `lazy-update-manager check` |
|
| `lazy-update-manager check` | Check for updates |
|
||||||
| Status anzeigen | `lazy-update-manager status` |
|
| `lazy-update-manager status` | Show available updates |
|
||||||
| Interaktiv aktualisieren | `lazy-update-manager update` |
|
| `lazy-update-manager update` | Run interactive full system update |
|
||||||
| Version prüfen | `lazy-update-manager version` |
|
| `lazy-update-manager version` | Print installed version |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Automatische Updates** – prüft offizielle Repos (`checkupdates` / `pacman -Qu`) und AUR (`paru` / `yay`)
|
- **Automatic updates** – checks official repos (`checkupdates` / `pacman -Qu`) and AUR (`paru` / `yay`)
|
||||||
- **Wöchentliche Erinnerung** – per `notify-send` oder `hyprctl notify`, maximal einmal pro Woche
|
- **Weekly reminder** – desktop notification via `notify-send` or `hyprctl notify`, at most once per week
|
||||||
- **Web-Oberfläche** – browsergestützte UI für Update-Suche, Filter, Pakete ignorieren, Systemstatus
|
- **Web UI** – browser-based interface for searching, filtering, ignoring packages, and system status
|
||||||
- **Desktop-App** – Electron-Wrapper für native Fenster-Integration
|
- **Desktop app** – Electron wrapper for native window integration
|
||||||
- **systemd-Timer** – prüft alle 2 Stunden, erinnert wöchentlich
|
- **systemd timer** – checks every 2 hours, reminds weekly
|
||||||
- **Einstellungen** – Terminal, Sprache (DE/EN), Auto-Refresh, Ignorierte Pakete, AUR an/aus
|
- **Settings** – terminal, language (DE/EN), auto-refresh, ignored packages, AUR toggle
|
||||||
- **Selektive Installation** – einzelne Pakete gezielt aktualisieren
|
- **Selective installs** – update individual packages when needed
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## GUI – Web & Desktop
|
## GUI – Web & Desktop
|
||||||
|
|
||||||
Die GUI bietet dir:
|
The GUI lets you:
|
||||||
|
|
||||||
| Funktion | Beschreibung |
|
| Feature | Description |
|
||||||
|----------|-------------|
|
|---------|-------------|
|
||||||
| 🔄 Refresh | Update-Liste manuell oder automatisch aktualisieren |
|
| 🔄 Refresh | Manual or automatic update list refresh |
|
||||||
| 🔍 Suche & Filter | Pakete nach Quelle (Repo/AUR) filtern und durchsuchen |
|
| 🔍 Search & filter | Filter packages by source (repo/AUR) |
|
||||||
| 📦 Selektive Installation | Nur bestimmte Pakete installieren |
|
| 📦 Selective install | Install only selected packages |
|
||||||
| 🙈 Pakete ausblenden | Noise-Reduktion durch Ignorieren |
|
| 🙈 Hide packages | Reduce noise by ignoring packages |
|
||||||
| 🖥️ Systemstatus | Pacman-Lock, Festplatte, Kernel, AUR-Helper, Terminal |
|
| 🖥️ System status | Pacman lock, disk space, kernel, AUR helper, terminal |
|
||||||
| ⚙️ Einstellungen | Timer, Terminal, Sprache, Auto-Refresh, Bestätigungen |
|
| ⚙️ Settings | Timer interval, terminal, language, auto-refresh, confirmation prompts |
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# Web-UI im Browser öffnen
|
# Open web UI in browser
|
||||||
lazy-update-manager gui web
|
lazy-update-manager gui web
|
||||||
|
|
||||||
# Desktop-App (wenn prefer_electron aktiviert)
|
# Open desktop app (when prefer_electron is enabled)
|
||||||
lazy-update-manager gui
|
lazy-update-manager gui
|
||||||
```
|
```
|
||||||
|
|
||||||
> Selektive Paket-Installs nutzen `pacman -S --needed` oder den AUR-Helper mit `-S --needed`.
|
> Selective installs use `pacman -S --needed` or the AUR helper with `-S --needed`.
|
||||||
> Full system updates sind auf Arch der sicherere Weg.
|
> Full system updates are the safer default on Arch – partial upgrades can cause dependency issues.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Mit install.sh (empfohlen)
|
### With install.sh (recommended)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./install.sh
|
./install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
- Prüft Abhängigkeiten (Go, Node.js, npm)
|
What it does:
|
||||||
- Installiert npm-Pakete (Electron)
|
- Checks dependencies (Go, Node.js, npm)
|
||||||
- Baut Go-Backend
|
- Installs npm packages (Electron)
|
||||||
- Kopiert Binary nach `~/.local/bin/`
|
- Builds the Go backend
|
||||||
- Legt Launcher `lazy-update-manager-electron` an
|
- Copies the binary to `~/.local/bin/`
|
||||||
- Installiert Desktop-Eintrag (für Wofi/Rofi)
|
- Creates the `lazy-update-manager-electron` launcher
|
||||||
- Aktiviert `prefer_electron` in der Config
|
- Installs the desktop entry (for app menus / launchers)
|
||||||
- Installiert und aktiviert systemd-Timer
|
- Enables `prefer_electron` in the config
|
||||||
|
- Installs and activates the systemd timer
|
||||||
|
|
||||||
### Manuell mit make
|
### With make
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make build # Nur Go-Backend bauen
|
make build # Build Go backend only
|
||||||
make install # Binary + Desktop + systemd installieren
|
make install # Install binary + desktop entry + systemd
|
||||||
make desktop # Electron-App im Dev-Modus starten
|
make desktop # Run Electron app in dev mode
|
||||||
make desktop-dist # Distribution bauen (AppImage, Pacman)
|
make desktop-dist # Build distribution packages (AppImage, Pacman)
|
||||||
```
|
```
|
||||||
|
|
||||||
### Electron-Distribution bauen
|
### Build Electron distribution
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./install.sh electron-dist
|
./install.sh electron-dist
|
||||||
```
|
```
|
||||||
|
|
||||||
### Aktualisieren
|
### Update
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git pull --ff-only
|
git pull --ff-only
|
||||||
@@ -106,41 +107,41 @@ git pull --ff-only
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Anforderungen
|
## Requirements
|
||||||
|
|
||||||
| Paket | Hinweis |
|
| Package | Notes |
|
||||||
|-------|---------|
|
|---------|-------|
|
||||||
| Arch Linux | – |
|
| Arch Linux | – |
|
||||||
| Go ≥ 1.22 | Zum Bauen |
|
| Go ≥ 1.22 | Required to build |
|
||||||
| `pacman-contrib` | Empfohlen für `checkupdates` |
|
| `pacman-contrib` | Recommended, provides `checkupdates` |
|
||||||
| `paru` / `yay` | Optional – für AUR-Updates |
|
| `paru` / `yay` | Optional – for AUR updates |
|
||||||
| `libnotify` | Optional – für `notify-send` |
|
| `libnotify` | Optional – for `notify-send` |
|
||||||
| Node.js + npm | Optional – für Electron-Desktop-App |
|
| Node.js + npm | Optional – for the Electron desktop app |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Desktop-App Details
|
## Desktop App Details
|
||||||
|
|
||||||
Der **Launcher** `~/.local/bin/lazy-update-manager-electron` startet Electron mit dem richtigen Arbeitsverzeichnis. Er wird vom Desktop-Eintrag (Wofi/Rofi) und intern von `lazy-update-manager gui` verwendet.
|
The **launcher** `~/.local/bin/lazy-update-manager-electron` starts Electron with the correct working directory. It is used by the desktop entry (app menu / launcher) and internally by `lazy-update-manager gui`.
|
||||||
|
|
||||||
Suchreihenfolge für das Projektverzeichnis:
|
Project directory lookup order:
|
||||||
1. `$LAZY_UPDATE_MANAGER_DIR` (Env-Variable)
|
1. `$LAZY_UPDATE_MANAGER_DIR` (environment variable)
|
||||||
2. Aktuelles Arbeitsverzeichnis (wenn `electron/main.cjs` existiert)
|
2. Current working directory (if `electron/main.cjs` exists)
|
||||||
3. Relativ zum Binary-Pfad
|
3. Relative to the binary path
|
||||||
4. `$HOME/Projekte/LazyUpdateManager`
|
4. `$HOME/Projekte/LazyUpdateManager`
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Daten & Konfiguration
|
## Data & Configuration
|
||||||
|
|
||||||
| Pfad | Inhalt |
|
| Path | Contents |
|
||||||
|------|--------|
|
|------|----------|
|
||||||
| `~/.config/lazy-update-manager/config.json` | Einstellungen (Terminal, Sprache, AUR, Timer, …) |
|
| `~/.config/lazy-update-manager/config.json` | Settings (terminal, language, AUR, timer, …) |
|
||||||
| `~/.local/state/lazy-update-manager/state.json` | Letzter Check, letzte Erinnerung, Update-Count |
|
| `~/.local/state/lazy-update-manager/state.json` | Last check, last reminder, update count |
|
||||||
| `~/.local/share/applications/lazy-update-manager.desktop` | Desktop-Eintrag für Menüs/Wofi |
|
| `~/.local/share/applications/lazy-update-manager.desktop` | Desktop entry for app menus |
|
||||||
| `~/.config/systemd/user/lazy-update-manager.{service,timer}` | systemd-Timer |
|
| `~/.config/systemd/user/lazy-update-manager.{service,timer}` | systemd timer files |
|
||||||
|
|
||||||
### Timer-Status prüfen
|
### Check timer status
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
systemctl --user status lazy-update-manager.timer
|
systemctl --user status lazy-update-manager.timer
|
||||||
@@ -149,6 +150,6 @@ systemctl --user list-timers lazy-update-manager.timer
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Lizenz
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|||||||
Reference in New Issue
Block a user