candifloss/icing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README: text formatting

Browse Source
This commit is contained in:
Candifloss 2025-12-18 10:26:29 +00:00
parent 960ca4489a
commit c2fac51705
1 changed files with 2 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -5,8 +5,6 @@
It sets a wallpaper directly on the X11 root window, without daemons, background services, or unnecessary dependencies.
Configuration is optional, and the app exits immediately after setting the wallpaper.
---
## Features
* Simple CLI usage
@ -24,11 +22,8 @@ Configuration is optional, and the app exits immediately after setting the wallp
```sh
icing --set /path/to/image.png
```
Sets the wallpaper immediately but does **not** update the config file.
---
### Update config and set wallpaper
```sh
@ -39,8 +34,6 @@ icing --update /path/to/image.png
* Sets the wallpaper immediately
* Future runs of `icing` will reuse this image
---
### Use config only
```sh
@ -50,8 +43,6 @@ icing
Uses the image path and settings from the config file.
Fails if no config exists.
---
### Optional arguments
```sh
@ -60,7 +51,6 @@ Fails if no config exists.
Overrides the default or configured scaling mode (see below).
---
## Configuration
@ -88,7 +78,6 @@ If `mode` is missing, **`fill` is used by default**.
Invalid modes cause `icing` to exit with an error.
---
## Scaling modes
@ -99,7 +88,6 @@ Invalid modes cause `icing` to exit with an error.
| Excess image cropped (centered) | Image may be stretched and distorted |
| Best choice for most wallpapers | Useful for exact fits or abstract images |
---
## Installation
@ -119,7 +107,6 @@ target/release/icing
Optionally move it to your `$PATH` (for example `/usr/bin/`) if desired.
---
## Requirements
@ -127,7 +114,6 @@ Optionally move it to your `$PATH` (for example `/usr/bin/`) if desired.
* A window manager
* Rust (for building)
---
## Future plans
@ -143,7 +129,6 @@ Optionally move it to your `$PATH` (for example `/usr/bin/`) if desired.
* Additional scaling modes (unless they make sense)
* Wayland support
---
## Notes