Skip to content

SUMMARY.md

Latest commit

 

History

History
171 lines (148 loc) · 4.54 KB

SUMMARY.md

File metadata and controls

171 lines (148 loc) · 4.54 KB
Raw

xfetch Dokumentation

Ein plattformunabhangiges Systeminformations-Tool geschrieben in Rust.

  • Version: 1.0.0
  • Lizenz: MIT
  • Autor: xscriptor
  • Repository: github.com/xfetch-cli/xfetch

Inhaltsverzeichnis

  1. Erste Schritte

    • Installationsmethoden (Schnellinstallation, manuell, Paketmanager)
    • Erster Start
    • Befehlszeilen-Schnittstelle im Uberblick
    • xfetch aktualisieren
    • Umgebungsvariablen

  2. Konfigurationsgenerierung

    • Grundlegende --gen-config-Nutzung
    • Distro-Logo (--logo) und Layout (--layout)
    • Offline-Fallbacks

  3. Konfiguration

    • JSONC-Konfigurationsdatei-Format
    • Alle Konfigurationsfelder
    • Modulgruppen
    • Icons und Farben
    • Plugin-Integration
    • Animationskonfiguration

  4. Module

    • Kernsystemmodule (OS, Kernel, Hostname, Uptime)
    • Hardwaremodule (CPU, GPU, Arbeitsspeicher, Swap, Festplatte, Akku)
    • Softwaremodule (Pakete, Shell, Terminal, WM/DE)
    • Netzwerkmodule (Lokale IP, Offentliche IP, Schnittstellen)
    • Benutzer-/Sitzungsmodule (Benutzer, Datum/Uhrzeit)
    • Spezialmodule (Palette, Header, Separator)
    • Plugin-Modulreferenzen

  5. Layouts

    • Klassisches Nebeneinander-Layout
    • Abschnittslayout mit Gruppen
    • Pac-Man-Layout
    • Seitenblock-Layout
    • Baum-Layout
    • Box-, Linien-, Punkt-, Untere-Linie-Varianten
    • Kompaktes Layout
    • Minimales Layout
    • Horizontales und Unteres Layout
    • Section-box- und Custom-X-Layouts

  6. Plugins

    • Plugin-Architektur im Uberblick
    • JSON-Drahtprotokoll
    • Plugin-Arten (Info-Anbieter, Logo-Animation)
    • Plugin-Erkennung und -Installation
    • Referenz der offiziellen Plugins
      • animate-logo
      • docker
      • github-stats
      • music-player
      • weather
      • timezone
      • user-info
      • display-resolution
      • theme-detection
      • chocolatey
      • temperature
      • theme-manager
      • wasm-crypto
      • wasm-ip-geo
      • wasm-pacman
      • wasm-proc
    • WebAssembly-Plugins (Manifest-Fahigkeiten und Host-Aufrufe)
    • Eigene Plugins schreiben
    • Plugin-API-Crate
    • WebAssembly guests (wasm.md)

  7. Erweiterungen

    • Erweiterungsarchitektur im Uberblick
    • Konfiguration uber config_providers
    • JSON-Drahtprotokoll
    • Installation und CLI-Befehle
    • Offizielle Erweiterungen
      • config-roulette
      • layout-override
      • wasm-night-mode
      • wasm-updates-footer
      • wasm-lang-labels
    • Eigene Erweiterungen schreiben

  8. Effekte

    • Architektur im Uberblick
    • Installation und CLI-Befehle
    • Konfiguration und Felder
    • JSON-Drahtprotokoll
    • Offizielle Effekte
    • WebAssembly-Effekte (wasm-matrix, wasm-python-pulse)
    • Eigene Effekte schreiben

  9. Anpassung

    • ASCII- und Bildlogos
    • Bildgrosse und Positionierung
    • Kitty Terminal Bild-Rendering
    • Logo-Animationsstile
    • Nerd Font Icons
    • ANSI-Farbanpassung
    • Paletten-Anzeigestile
    • Preset-Konfigurationen

  10. Fortgeschrittene Nutzung

  • Benchmark-Modus
  • Cache-System
  • Datenschutzeinstellungen
  • Plattformubergreifendes Verhalten
  • Leistungsoptimierung
  1. Presets-Referenz
  • Layout-Presets
  • Showcase-Presets
  • Plugin-Presets
  • Full-Stack-Preset
  1. Themes
  • Architektur und Zusammenfuhlungsreihenfolge
  • Theme-Dateiformat
  • Theme-Auflosung und CLI-Befehle
  • Integrierte Themes

  1. Theme Manager Plugin

    • Ubersicht und Installation
    • Aktionen (list, search, info, install)
    • Registry und benutzerdefinierte Registries

  2. Mitwirken

    • Aus dem Quellcode bauen
    • Projektstruktur
    • Plugin-Entwicklungsleitfaden
    • Testen
    • Pull-Request-Prozess

  3. Fahrplan

    • Vergangene Phasen (Grundlage, Module, Layouts, Dokus)
    • Aktuelle Phase (Tests, erweiterte Funktionen)
    • Zukunftsplane

  4. Sicherheit

    • Melden von Sicherheitslucken
    • Sicherheitsempfehlungen
    • Unterstutzte Versionen

  5. Support

    • Hilfe erhalten
    • Vor dem Offnen eines Issues
    • Reaktionserwartungen

  6. Anderungsprotokoll

    • Versionsgeschichte
    • Phasenweises Anderungsprotokoll

  7. Verhaltenskodex

    • Unsere Standards
    • Inakzeptables Verhalten
    • Melden

  8. Lizenz

    • MIT-Lizenzbestimmungen