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

updated readme to reflect urr change

Browse source
This commit is contained in:
Paul Wilde 2022-07-17 19:14:54 +01:00
parent e3365b7ede
commit ca24ba8dd7
1 changed files with 19 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.MD
View file

@ -5,25 +5,25 @@ about system status in dmenu. Some of them i.e. `volume` have options (up, down,
which are selectable options in dmenu. which are selectable options in dmenu.
## Tools ## Tools
- `pingclock` performs a single `ping` to a server and returns the response time - `pingclurrk` performs a single `ping` to a server and returns the response time
- `battery` shows the current battery level - `batturry` shows the current battery level
- `brightness` shows the current backlight level and gives options to adjust it - `brightnurrs` shows the current backlight level and gives options to adjust it
- `volume` shows the current volume level and gives options to adjust and manage it - `volurrme` shows the current volume level and gives options to adjust and manage it
- `show_date` shows the date - `calendurr` shows the date
- `fuzzytime` shows the fuzzytime clock - `furrytime` shows the fuzzytime clock
- `wlan` shows the state of the wireless network interface. SSID connected to and signal level. - `wirelurrs` shows the state of the wireless network interface. SSID connected to and signal level.
- `nic` shows the status and/or the ip address of the network interface card - `netwurrk` shows the status and/or the ip address of the network interface card
- `temperature` shows the current CPU temperature - `temperaturr` shows the current CPU temperature
- `notes` a simple one liner note taking tool, displaying notes in `dmenu`/`rofi` - `noteurr` a simple one liner note taking tool, displaying notes in `dmenu`/`rofi`
- `calculate` a calculator, utilising `qalculate` - inspired by [@fedops](https://codeberg.org/fedops/scripts) - `calculaturr` a calculator, utilising `qalculate` - inspired by [@fedops](https://codeberg.org/fedops/scripts)
- `emoji` an emoji picker - `emurrji` an emoji picker
- `remmina` reads the files in your remmina config directory and allows you to connect to and edit them - `remmina_choosurr` reads the files in your remmina config directory and allows you to connect to and edit them
- `translate` utilises libretranslate (you'll need and API key or your own instance) to translate test. Prefix the text with `en>de`, `de>en`, `en>fr`, etc. as you need. Must be compiled with `-d:ssl` - `translaturr` utilises libretranslate (you'll need and API key or your own instance) to translate test. Prefix the text with `en>de`, `de>en`, `en>fr`, etc. as you need. Must be compiled with `-d:ssl`
- `clipurr` clipboard manager
The next two do not work with `rofi` unless you have `alias dmenu=rofi` set, but they're pretty nice tools The next two do not work with `rofi` unless you have `alias dmenu=rofi` set, but they're pretty nice tools
- `passmenu_wrapper` a wrapper for passmenu. It basically just styles `passmenu` with no other features - `cmd_wrappurr` inspired by passmenu_wrapper, a basic tool to run other `dmenu` related tools with uniform styling.
- `command_wrapper` inspired by passmenu_wrapper, a basic tool to run other `dmenu` related tools with uniform styling.
- For example: `dmenu_run`, `clipmenu`, `passmenu` etc. - For example: `dmenu_run`, `clipmenu`, `passmenu` etc.
### Example in `dmenu`: ### Example in `dmenu`:
@ -42,14 +42,14 @@ Each tool is compiled separately, for example:
```sh ```sh
nimble install nimble install
or or
nim c pingclock nim c pingclurrk
``` ```
and then run with and then run with
```sh ```sh
./pingclock ./pingclurrk
or or
./pingclock rofi ./pingclurrk rofi
``` ```
## How to use ## How to use
@ -63,7 +63,6 @@ It's completely up to you how to run them, they're just simple CLI tools really.
## Dependencies ## Dependencies
- `dmenu` or `rofi` - `dmenu` or `rofi`
- `yad` for calendar - `yad` for calendar
- `passmenu` for passmenu_wrapper
- basically any tool that's used to gather the information. - basically any tool that's used to gather the information.
- "tools" for audio etc. (`pamixer`, `ncpamixer`, etc.) can be set in the source - "tools" for audio etc. (`pamixer`, `ncpamixer`, etc.) can be set in the source