diff options
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | battery-widget/README.md | 15 | ||||
| -rw-r--r-- | brightness-widget/README.md | 2 | ||||
| -rw-r--r-- | volumebar-widget/README.md | 4 |
4 files changed, 12 insertions, 19 deletions
@@ -1,5 +1,5 @@ -# AwesomeWM - +# Awesome WM widgets + Set of super simple widgets compatible with Awesome Window Manager v.4+.  @@ -21,8 +21,8 @@ From left to right: - [batteryarc-widget](https://github.com/streetturtle/AwesomeWM/tree/master/batteryarc-widget) - [battery-widget](https://github.com/streetturtle/AwesomeWM/tree/master/battery-widget) -These widgets use [Arc icon theme](https://github.com/horst3180/arc-icon-theme) by default but it could be easily -changed to any other icon theme. If you want to have separators between widgets like on the screenshot create text widget with ` : ` and place it between widgets: +Some of these widgets use [Arc icon theme](https://github.com/horst3180/arc-icon-theme) by default but it could be easily +changed to any other icon theme or custom icons. If you want to have separators between widgets like on the screenshot create text widget with ` : ` and place it between widgets: ```lua ... @@ -39,7 +39,7 @@ sprtr, # Installation -Clone repo under **~/.config/awesome/**, then in **rc.lua** add the import of the widget you'd like to use in "require" section on the top of the file: +Clone the repo under **~/.config/awesome/**, then in **rc.lua** add the import of the widget you'd like to use in "require" section on the top of the file: ```lua require("awesome-wm-widgets.battery-widget.battery") diff --git a/battery-widget/README.md b/battery-widget/README.md index 4a69c1d..7826430 100644 --- a/battery-widget/README.md +++ b/battery-widget/README.md @@ -26,17 +26,4 @@ $ acpi Battery 0: Discharging, 66%, 02:34:06 remaining ``` -- clone/copy **battery.lua** file to **~/.config/awesome/** folder; - -- include **battery.lua** and add battery widget to your wibox in **rc.lua**: - -```lua -require("battery") -... -s.mytasklist, -- Middle widget - { -- Right widgets - layout = wibox.layout.fixed.horizontal, - ... - battery_widget, - ... -``` +Then refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo. diff --git a/brightness-widget/README.md b/brightness-widget/README.md index d7690b4..ca33fd3 100644 --- a/brightness-widget/README.md +++ b/brightness-widget/README.md @@ -45,6 +45,8 @@ s.mywibox:setup { brightness_widget ``` +## Controls + In order to change brightness by shortcuts you can add them to the `globalkeys` table in the **rc.lua**: ```lua diff --git a/volumebar-widget/README.md b/volumebar-widget/README.md index 8254b49..2198f6d 100644 --- a/volumebar-widget/README.md +++ b/volumebar-widget/README.md @@ -23,3 +23,7 @@ s.mytasklist, -- Middle widget volumebar_widget, ... ``` + +## Troubleshooting + +If the bar is not showing up, try to decrease top or bottom margin - widget uses hardcoded margins for vertical alignment, so if your wibox is too small then bar is simply hidden by the margins. |