Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
0xk1f0 committed Feb 25, 2023
1 parent 4f446ed commit 5e465a1
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ WIP Wallpaper Utility written in Rust
## Features

- Spans an input wallpaper across all monitors
- Intended to work alongside [Hyprland](https://hyprland.org/)
- Works alongside [Hyprland](https://hyprland.org/)
- Uses [wpaperd](https://github.com/danyspin97/wpaperd) as wallpaper daemon
- Code quality is probably pretty poor as I'm new to Rust

## Building
Expand All @@ -23,14 +24,23 @@ cargo build --release
# screens are automatically read
# if running a Hyprland session
rwpspread -i <image>

# for example
rwpspread -i /some/path/wallpaper.png

# to use the wpaperd integration
# this autogenerates the config file
# you will need to have wpaperd installed
rwpspread -w -i /some/path/wallpaper.png

# for more info
rwpspread --help
```

## Checklist

- [x] splitting for dual screen layout
- [x] splitting for any screen layout (two or more screens)
- [x] Hyprland Integration
- [x] wpaperd Integration
- [ ] restore standalone support
- [ ] wpaperd Integration

0 comments on commit 5e465a1

Please sign in to comment.