diff --git a/Cargo.lock b/Cargo.lock index f145084..ea1fc2d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -60,7 +60,7 @@ checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" [[package]] name = "breadpaper" -version = "0.1.0" +version = "0.1.10" dependencies = [ "anyhow", "clap", diff --git a/Cargo.toml b/Cargo.toml index da29e25..e4a1ada 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "breadpaper" -version = "0.1.0" +version = "0.1.10" edition = "2024" description = "Wallpaper manager for the bread desktop" license = "MIT" diff --git a/README.md b/README.md new file mode 100644 index 0000000..dc43320 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# breadpaper + +Wallpaper manager for the bread desktop. Sets a wallpaper via [awww](https://github.com/heywoodlh/awww), generates a colour palette with [pywal](https://github.com/dylanaraps/pywal), and reloads bread themes in one command. + +## Dependencies + +Runtime: + +- `awww` — Wayland wallpaper daemon +- `python-pywal` — colour palette generation +- `bread-theme` — theme reload (part of the bread ecosystem) + +Build: + +- Rust 1.85+ (edition 2024) / cargo + +## Install + +**From the bakery (recommended on bread OS):** + +``` +bakery install breadpaper +``` + +**From source:** + +``` +cargo build --release +install -Dm755 target/release/breadpaper ~/.local/bin/breadpaper +``` + +**Arch Linux (PKGBUILD):** + +``` +cd packaging/arch +makepkg -si +``` + +## Usage + +``` +breadpaper # set wallpaper (shorthand for `set`) +breadpaper set # set wallpaper, generate palette, reload themes +breadpaper get # print the current wallpaper path +``` + +Supported formats: `png`, `jpg`, `jpeg`, `webp`, `gif`, `bmp`. + +The current wallpaper path is stored by pywal at `~/.cache/wal/wal`. + +## License + +MIT — see [LICENSE](LICENSE).