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

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