psw/wmtools
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

updated readme with brief descriptions of each tool

Browse source
This commit is contained in:
Paul Wilde 2022-05-03 21:50:04 +01:00
parent 75201b189f
commit b42df0a6fe
1 changed files with 24 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.MD
View file

@ -4,29 +4,6 @@ These are a selection of independant tools for displaying various information
about system status in dmenu. Some of them i.e. `volume` have options (up, down, mute...)
which are selectable options in dmenu.
Example in dmenu:
https://user-images.githubusercontent.com/31094984/166115207-c24e9ec8-136e-4956-9842-bcde496bb743.mp4
Example in rofi:
https://user-images.githubusercontent.com/31094984/166115213-511fdaaa-4c04-461a-9976-38a2e9bd83fe.mp4
They are compiled separately, for example:
```nim
nim c pingclock
```
and then run with
```sh
./pingclock dmenu
or
./pingclock rofi
```
it can also be run without any arguments to receive a i3bar compatible json string
## Tools
- `pingclock` performs a single `ping` to a server and returns the response time
- `battery` shows the current battery level
@ -39,13 +16,35 @@ it can also be run without any arguments to receive a i3bar compatible json stri
- `temperature` shows the current CPU temperature
- `notes` a simple one liner note taking tool, displaying notes in dmenu/rofi
### Example in dmenu:
https://user-images.githubusercontent.com/31094984/166115207-c24e9ec8-136e-4956-9842-bcde496bb743.mp4
### Example in rofi:
https://user-images.githubusercontent.com/31094984/166115213-511fdaaa-4c04-461a-9976-38a2e9bd83fe.mp4
## How to use
They are compiled separately, for example:
```nim
nim c pingclock
```
and then run with
```sh
./pingclock dmenu
or
./pingclock rofi
```
it can also be run without any arguments to receive a i3bar compatible json string
Personally, I have these bound to key combinations in i3. In fact, I have a seperate `bindsym` mode in which all these tools are accessible i.e. `$mod+i` to get to "info" mode then `p` to show pingclock.
## You can also set the volume and brightness levels by typing a numeric figure into the dmenu/rofi input box
### You can also set the volume and brightness levels by typing a numeric figure into the dmenu/rofi input box
https://user-images.githubusercontent.com/31094984/166156793-2089cc10-2649-4079-b82d-bba272253dd6.mp4
There's also an i3bar_tools_threaded folder with tools for use with i3bar/i3blocks which continously update. Currently these are not working as I recently switched from this as primary, to a secondary choice.
These have some configuration variables explicit to me, you'll need to change them for you for them to be useful I imagine.