FunctionalHacker/lqsd
2
0
Fork 0
Code Issues Pull requests Releases 2 Wiki Activity

Improve readme

Browse source 
Signed-off-by: Marko Korhonen <marko.korhonen@reekynet.com>
This commit is contained in:
Marko Korhonen 2020-01-19 22:01:41 +02:00
parent f10e1147f7
commit a993767b4e
No known key found for this signature in database
GPG key ID: 911B85FBC6003FE5
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,8 +1,7 @@
# LiQuid Screen Dim
A simple utility which dims your screen. It saves the previous brightness too, so you can restore to the point before dimming.
## Why Rust?
I wanted start a small project to learn Rust. Before this, I was using [this script](https://github.com/Bonnee/dotfiles/blob/wayland/scripts/bin/dim.sh) and figured, why not rewrite it in Rust.
This is useful if you are running a standalone screen locking setup like swayidle/swaylock. Check out [my configuration files](https://git.reekynet.com/ReekyMarko/dotfiles/src/branch/master/home/Scripts/swayidle.sh) for an example use case.
## Usage
```
@ -20,10 +19,12 @@ OPTIONS:
```
The configuration file resides at `$XDG_CONFIG_HOME/lqsd/config.toml`. There you can set these values:
`resume_file_path`: the location where the previous brightness is saved (default: `/tmp/lqsd-resume`)
| Key | Explanation |
| ---------------- | -------------------------------------------------------------------------------------------- |
| resume_file_path | The location where the previous brightness is saved (default: "/tmp/lqsd-resume") |
| idle_level | the minimum brightness that will be dimmed to. Can be a value between 0-100 (default 0) |
| dim_speed | this sets the "sleep time" between each backlight command. It's in milliseconds (default 50) |
| resume_speed | same as dim_speed, only for the resume operation `-r` (default 25) |
`idle_level`: the minimum brightness that will be dimmed to. Can be a value between 0-100 (default 0)
`dim_speed`: this sets the "sleep time" between each backlight command. It's in milliseconds (default 50)
`resume_speed`: same as the last one, only for the resume operation `-r` (default 25)
## Why Rust?
I wanted start a small project to learn Rust. Before lqsd, I was using [this script](https://github.com/Bonnee/dotfiles/blob/wayland/scripts/bin/dim.sh) and figured, why not rewrite it in Rust.