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.
This commit is contained in:
parent
1671af82ee
commit
168a449edf
3 changed files with 55 additions and 2 deletions
2
Cargo.lock
generated
2
Cargo.lock
generated
|
|
@ -60,7 +60,7 @@ checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "breadpaper"
|
name = "breadpaper"
|
||||||
version = "0.1.0"
|
version = "0.1.10"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"clap",
|
"clap",
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "breadpaper"
|
name = "breadpaper"
|
||||||
version = "0.1.0"
|
version = "0.1.10"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
description = "Wallpaper manager for the bread desktop"
|
description = "Wallpaper manager for the bread desktop"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
|
|
|
||||||
53
README.md
Normal file
53
README.md
Normal file
|
|
@ -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 <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).
|
||||||
Loading…
Add table
Add a link
Reference in a new issue