From 732794d2822a6674c1f9eea427d56d88d0fbb1e2 Mon Sep 17 00:00:00 2001 From: Simon Vieille Date: Tue, 30 Jul 2024 21:54:22 +0200 Subject: [PATCH] update readme --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d80f281..fe0ead8 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,18 @@ $ make ## 🧪 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 +```