update README to match the new innerworkings

This commit is contained in:
Late Night Defender 2025-05-16 02:10:55 +07:00
parent e0beafb46e
commit a929db7ba0

View file

@ -11,28 +11,11 @@ So instead of a GNOME Shell extension, we created a Python script that does ever
## How to use ## How to use
1. Create a directory with desired photos and note its full path 1. Create a directory with desired photos and note its full path
2. In that directory, rename your photos according to this table 2. In that directory, append color codes to the files such as from `example.jpg` to `example-blue.jpg`. Possible color codes are `blue`, `teal`, `green`, `yellow`, `orange`, `red`, `pink` and `purple`. If other colors are set or there is no color code at all, we'll set the color to neutral `slate`.
3. Put `change-wallpaper.py` to `~/.local/bin` and make sure it is in your `$PATH`
*Suppose the filename is example.jpg* 4. In `change-wallpaper.service` replace `/path/to/dir` accordingly.
5. **Optionally**, modify `change-wallpaper.timer` as needed. The default is set to *every 15 minutes*.
|Accent Color |Suffix |Expected filename | 6. Put `change-wallpaper.service` and `change-wallpaper.timer` in `~/.config/systemd/user/` and run these commands to get started
|--------------|-------|-------------------|
|Blue |blue |example-blue.jpg |
|Teal |teal |example-teal.jpg |
|Green |gree |example-gree.jpg |
|Yellow |yell |example-yell.jpg |
|Red |redd |example-redd.jpg |
|Pink |pink |example-pink.jpg |
|Purple |purp |example-purp.jpg |
|Slate |- |*any file without valid suffix above*|
*This means if there is no valid color suffix at the end of file name, we will set the accent color to Slate.*
3. In `change-wallpaper.py`, replace the `directory_path` with the path from step 1
4. Put `change-wallpaper.py` to `~/.local/bin` and make sure it is in your `$PATH`
5. In `change-wallpaper.service` replace `youruser` in `ExecStart` line with your actual username.
6. **Optionally**, modify `change-wallpaper.timer` as needed. The default is set to *every 15 minutes*.
7. Put `change-wallpaper.service` and `change-wallpaper.timer` in `~/.config/systemd/user/` and run these commands to get started
``` ```
$ systemctl --user daemon-reload $ systemctl --user daemon-reload