breadpaper/README.md
Breadway 168a449edf breadpaper: commit README, align Cargo.toml version with tag
- README.md existed only in the working tree and was never committed,
  so the published repo/release tarball shipped with no documentation
  at all. Verified its usage/install instructions against the current
  code before committing; corrected the stated Rust requirement from
  1.80+ to 1.85+ (edition 2024 needs 1.85+).
- Cargo.toml: 0.1.0 -> 0.1.10, matching the latest tag (v0.1.10).
  breadpaper --version previously reported nine releases behind the
  actual release history.
2026-07-17 03:20:48 +08:00

53 lines
1.1 KiB
Markdown

# 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 <path> # set wallpaper (shorthand for `set`)
breadpaper set <path> # 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).