deblan/i3-wallpaper-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages 1 Wiki Activity Actions

update readme
Some checks are pending
ci/woodpecker/push/build Pipeline is pending approval
Details
ci/woodpecker/push/test Pipeline is pending approval
Details

Browse source
This commit is contained in:
Simon Vieille 2024-07-30 21:54:22 +02:00
commit 732794d282
Signed by: deblan
GPG key ID: 579388D585F70417
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -15,4 +15,18 @@ $ make
## 🧪 How to use the project ## 🧪 How to use the project
TODO. To start, you need to create a configuration file in YAML format. This file consists of two keys: `default` to define the path of the default wallpaper, and `workspaces` which allows you to associate each workspace with its corresponding wallpaper.
```
default: /home/alice/wallpapers/default.jpg
workspaces:
"Name of the workspace 1": /home/alice/wallpapers/1.jpg
"Name of the workspace 2": /home/alice/wallpapers/2.jpg
"Name of the workspace 3": /home/alice/wallpapers/3.jpg
```
Next, you simply need to run `i3-wallpaper-manager` while specify the path to the configuration file.
```
i3-wallpaper-manager ./config.yaml
```