From 69a972fac87b0a4b5b37903fcd65523e65f11bae Mon Sep 17 00:00:00 2001 From: tittu Date: Fri, 12 Jun 2026 15:48:00 +0530 Subject: [PATCH] readme update --- README.md | 23 +++++++++++++---------- src/main.rs | 2 +- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9d5e6b6..08a59c5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# wallbash +# waLLbash A fast and minimal wallpaper engine for HyDE Use `wallbash` as a core component of your Wayland desktop environment — set wallpapers, generate color palettes, and dynamically theme your desktop. @@ -12,7 +12,7 @@ Use `wallbash` as a core component of your Wayland desktop environment — set w - Multi-monitor support (WIP) -## Build from source +## Build ```bash git clone https://github.com/prasanthrangan/wallbash @@ -31,21 +31,24 @@ wallbash stop # Stop the daemon wallbash status # Show daemon status ``` - -## How It Works - The Rust binary compiles to a single executable, `wallbash`. It acts as both a client and a daemon: - `wallbash start` Launches the daemon (background process). The daemon initializes the Wayland and Vulkan subsystems and listens for commands on a Unix socket. -- `wallbash set` Sends a command via the Unix socket to the daemon to load and display the image. If the daemon is not running, it automatically starts it and waits for it to be ready before sending the command. -- `wallbash status` Query the daemon status. +- `wallbash set` Sends a command to load and display the image. If the daemon is not running, it automatically starts it and waits for it to be ready before sending the command. - `wallbash stop` Terminate the daemon. +- `wallbash status` Query the daemon status. -The daemon uses Vulkan (`ash`) for GPU-accelerated rendering and `wlroots` Wayland protocols to display the wallpaper as a layer surface. +## Architecture -### Architecture +``` +src/ +├── main.rs +├── wallbashed.rs +├── wayland.rs +└── vulkan.rs +``` -The project is structured in modules: +The project is structured in simple modules: - `main.rs` Entry point of the binary. Works as a CLI tool to parse arguments and handle the daemon. - `wallbashed.rs` The core daemon module. It manages the IPC listener, handles incoming commands, and orchestrates the wallpaper loading and rendering process. - `wayland.rs` Handles the Wayland integration. It creates a Wayland surface, binds to the layer shell protocol, and sets up the layer surface for the wallpaper. diff --git a/src/main.rs b/src/main.rs index 1a3494e..cc398ea 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,6 +1,6 @@ // --------------------------------------------------------------------- / tittu // wallbash -// a minimal wallpaper engine for HyDE +// a fast and minimal wallpaper engine for HyDE //