awesomewm-mirrors
/
awesome-wm-widgets
mirror of https://github.com/streetturtle/awesome-wm-widgets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

ram-widget: document arguments

This commit is contained in:
Nuno Silva 2021-04-11 19:40:51 +01:00
parent 42dd36c604
commit 94f9aef1c5
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
ram-widget/README.md
View File

@ -4,6 +4,18 @@ This widget shows the RAM usage. When clicked another widget appears with more d
![screenshot](./out.gif) ![screenshot](./out.gif)
## Customization
It is possible to customize widget by providing a table with all or some of the following config parameters:
| Name | Default | Description |
|---|---|---|
| `color_used` | `beautiful.bg_urgent` | Color for used RAM |
| `color_free` | `beautiful.fg_normal` | Color for free RAM |
| `color_buf` | `beautiful.border_color_active` | Color for buffers/cache |
| `widget_show_buf` | `false` | Whether to display buffers/cache separately in the tray widget. If `false`, buffers/cache are considered free RAM. |
| `timeout` | 1 | How often (in seconds) the widget refreshes |
## Installation ## Installation
Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo. Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo.