Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
Matt Turner committed Mar 7, 2021
1 parent 89bd075 commit 91c643a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,21 @@ Uses the [lm-sensors](https://github.com/lm-sensors/lm-sensors) (linux monitorin
* Run `sensors-detect`
* Make any [necessary adjustments](https://hwmon.wiki.kernel.org/faq) to the [configuration](https://linux.die.net/man/5/sensors3.conf) in `/etc/sensors3.conf`, using `/etc/sensors.d/*`
* Download `polybar-lmsensors` binary from TODO
* Or, with the _go_ toolchain installed, build it manually with `go get github.com/mt-inside/polybar-lmsensors`

## Example

### Manual Execution
```
$ polybar-lmsensors -t -n -u it8688-isa-0a40/SYS_FAN2=sys k10temp-pci-00c3/Tdie
Fan sys 825/min, Temp Tdie 41°C
```

### Polybar Config
```
[module/sensors-cpu]
type = custom/script
interval = 2
format-prefix = " "
exec = $GOPATH/bin/polybar-lmsensors -u -n -t k10temp-pci-00c3/Tdie it8688-isa-0a40/CPU_FAN=cpu
```

0 comments on commit 91c643a

Please sign in to comment.