diff --git a/README.md b/README.md index b942e65..e4a8c27 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,18 @@ Use `wallbash` as a core component of your Wayland desktop environment — set w - Scale the image to your liking using cover, fit, or original modes - Precise anchor point positioning from 1 to 9 for fine‑tuned wallpaper placement - Automatic background blur fill for mismatched aspect ratios, eliminating black bars +- Persistent settings cache to save your setup between sessions - Fluid transitions and animations* -- Multi-monitor support*
*work in progress
+## Requirements + +- **Wayland compositor** that supports layer-shell protocol +- **GPU** with vulkan drivers installed +- **Rust & Cargo** required to build from source + + ## Build ```bash @@ -34,7 +41,6 @@ sudo cp target/release/wallbash /usr/local/bin/ ## Usage ```bash -wallbash start # Start the wallpaper daemon wallbash set /path/to/file.img # Set wallpaper (auto start daemon) wallbash stop # Stop the daemon wallbash status # Show daemon status @@ -51,16 +57,7 @@ wallbash set [option] ## Architecture -Wallbash is a **single binary** that can run in two modes: - -- **Client Mode:** Run wallbash set --wall ... to set a wallpaper. The command either: - - Connects to an existing daemon and sends the command, or - - Starts the daemon automatically if it's not already running, then sends the command. - -- **Daemon Mode:** Run wallbash start to explicitly launch the daemon, or let it be started automatically on first use. The daemon: - - Manages the Wayland surface and Vulkan rendering pipeline. - - Listens for commands via a Unix socket (/tmp/wallbash.sock). - - Persists in the background until stopped with wallbash stop. +Wallbash is a single binary that runs a background daemon and processes client requests via a Unix socket /tmp/wallbash.sock. The core **modules** are structured as: @@ -79,3 +76,4 @@ For detailed guides, usage, and application specific examples, check out the [wi ###### *
// HyDE
*

+