diff --git a/README.md b/README.md index 473d663..3b5f119 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@
-

CachyOS Welcome

+

CachyOS Hello

Welcome screen for CachyOS written in Rust

-![CachyOS-Welcome v.0.16.4](https://github.com/user-attachments/assets/b555d6a5-9550-4869-9a41-734a09d806bf) - - +![CachyOS-Hello](assets/screenshot.png) [![Dependency Status](https://deps.rs/repo/github/cachyos/cachyos-welcome/status.svg)](https://deps.rs/repo/github/cachyos/cachyos-welcome)
@@ -15,3 +13,75 @@

+ +## Overview + +CachyOS Hello is a GTK3 application that serves as the main entry point for new CachyOS users. It provides a graphical interface for system setup, maintenance, and configuration — including service tweaks, one-click fixes, encrypted DNS configuration, quick access to CachyOS tools (Package Installer, Kernel Manager), and a guided installer path on live ISO. Supports 32 languages with runtime locale switching. Also ships a full CLI for scripting and automation. + +## CLI + +``` +cachyos-hello +``` + +### `fix ` + +| Action | Description | +|---|---| +| `update-system` | Update all system packages | +| `reinstall-packages` | Reinstall all native packages | +| `reset-keyrings` | Reset and repopulate pacman keyrings | +| `remove-lock` | Remove pacman database lock file | +| `clear-cache` | Clear package cache | +| `remove-orphans` | Remove orphan packages | +| `rank-mirrors` | Rank mirrors by speed | +| `install-gaming` | Install gaming meta-packages | +| `install-winboat` | Install Winboat | +| `show-kwin-debug` | Open KWin Wayland debug console | + +### `tweak ` + +``` +cachyos-hello tweak enable +cachyos-hello tweak disable +cachyos-hello tweak list +``` + +Available tweaks: `psd`, `oomd`, `bpftune`, `bluetooth`, `ananicy`, `cachy-update` + +### `dns ` + +``` +# Use a preconfigured provider +cachyos-hello dns set --connection --server [--dot] [--doh] + +# Use custom DNS addresses +cachyos-hello dns set-custom --connection [--ipv4 ] [--ipv6 ] [--dot] [--doh-url ] + +# Reset to automatic +cachyos-hello dns reset --connection + +# List available connections / providers / test latency +cachyos-hello dns list-connections +cachyos-hello dns list-servers +cachyos-hello dns test-latency +``` + +--- + +## Building + +**Dependencies:** gtk+-3.0, glib-2.0, gio-2.0, Rust toolchain, Meson + +```sh +meson setup build +meson compile -C build +meson install -C build # optional +meson test -C build # optional +``` + +--- + +## License + +GPL-3.0 — see [LICENSE](LICENSE) for details. diff --git a/assets/screenshot.png b/assets/screenshot.png new file mode 100644 index 0000000..848a046 Binary files /dev/null and b/assets/screenshot.png differ