Improve readme

This commit is contained in:
Vyn 2024-06-03 09:35:53 +02:00
parent 0d840f0d50
commit fce4fad1fb
4 changed files with 11 additions and 14 deletions

View file

@ -13,7 +13,7 @@ Display wallpapers on Sway, this is essentially a wrapper for `swaybg`.
## Usage
```sh
```
usage: sway-wallpaper [options] <path> <output>
required:
@ -21,12 +21,15 @@ required:
path The path to the directory containing the wallpapers
options:
--always-random if set, always randomize the next wallpaper
-h, --help Show help
-i, --interval Specify the interval between
-i, --interval Specify the interval between wallpapers in seconds
--never-random if set, wallpapers order is based on the names of the files
```
Example:
`./sway-wallpaper /path/to/wallpapers -i 3600 DP-1`
## Installation
First, clone this repository `git clone https://codeberg.org/vyn/sway-wallpaper.git` (or download it the way you prefer).
@ -36,7 +39,7 @@ You only need **gcc** and **cmake**, run these commands in the project directory
```
mkdir build
cd build
cmake ..
cmake -DCMAKE_BUILD_TYPE=Release ..
make
```