Skip to content

Commit

Permalink
docs: Add prerequisites and configuration sections to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bcyran committed Oct 25, 2022
1 parent 2e11278 commit 1397207
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ Features:

---

## Installation
### Prerequisites
`timewall` depends on [`libheif`](https://github.com/strukturag/libheif) for HEIF support, make sure you have it installed.
If you're building it from source you may also need `libheif-dev`, depending on your distribution.

## Usage
### Initial configuration
If you intend to use sun position based wallpapers, you need to provide `timewall` with your approximate location.
Expand Down Expand Up @@ -103,6 +108,16 @@ All metadata known to `timewall` can be displayed using:
timewall info path/to/wallpaper.heif
```

### Configuration
#### Custom wallpaper setting command
If the default wallpaper setting doesn't work in your case for some reason, or you just want to customize it, you can specify custom command tu use.
For instance, to set the wallpaper using `feh`, you could add the following to your `~/.config/timewall/config.toml`:
```toml
[setter]
command = ['feg', '--bg-fill', '%f']
```
`%f` is a placeholder which will be replaced with full absolute path to the image, which should be set as a wallpaper.

## Resources / credits
The following resources helped me in `timewall` development:
- https://itnext.io/macos-mojave-dynamic-wallpaper-fd26b0698223
Expand Down

0 comments on commit 1397207

Please sign in to comment.