awesome-wm-widgets/README.md

72 lines
2.5 KiB
Markdown
Raw Normal View History

2015-07-12 16:03:35 +02:00
# AwesomeWM
2015-07-16 13:09:42 +02:00
2017-02-02 02:52:08 +01:00
Set of super simple widgets compatible with Awesome Window Manager v.4.
2016-04-29 11:59:35 +02:00
2017-02-02 02:52:08 +01:00
![screenshot](https://github.com/streetturtle/AwesomeWM/blob/master/screenshot.png?raw=true)
2017-02-02 02:59:04 +01:00
From left to right:
2017-01-31 21:12:32 +01:00
2017-02-02 02:59:04 +01:00
- [spotify-widget](https://github.com/streetturtle/AwesomeWM/tree/master/spotify-widget) / [rhythmbox-widget](https://github.com/streetturtle/AwesomeWM/tree/master/rhythmbox-widget)
2017-02-08 02:31:34 +01:00
- [weather-widget](https://github.com/streetturtle/AwesomeWM/tree/master/weather-widget)
2017-01-31 21:12:32 +01:00
- [email-widget](https://github.com/streetturtle/AwesomeWM/tree/master/email-widget)
2017-02-02 02:59:04 +01:00
- [brightness-widget](https://github.com/streetturtle/AwesomeWM/tree/master/brightness-widget)
2017-01-31 21:12:32 +01:00
- [volume-widget](https://github.com/streetturtle/AwesomeWM/tree/master/volume-widget)
2017-02-02 02:59:04 +01:00
- [battery-widget](https://github.com/streetturtle/AwesomeWM/tree/master/battery-widget)
2017-09-11 20:30:31 +02:00
- [volumebar-widget](https://github.com/streetturtle/AwesomeWM/tree/master/volumebar-widget) (not on the screenshot)
2017-09-28 01:49:30 +02:00
- [cpu-widget](https://github.com/streetturtle/AwesomeWM/tree/master/cpu-widget) (not on the screenshot)
2017-02-02 02:52:08 +01:00
2017-02-05 19:18:06 +01:00
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:
2017-02-02 17:24:34 +01:00
```lua
...
sprtr = wibox.widget.textbox()
sprtr:set_text(" : ")
...
sprtr,
volume_icon,
sprtr,
battery_widget,
sprtr,
...
```
2017-02-02 02:52:08 +01:00
# Installation
2017-02-02 02:59:04 +01:00
[Install](https://github.com/horst3180/arc-icon-theme#installation) Arc icon theme and follow installation instructions of each widget.
2017-06-21 22:50:58 +02:00
Or you can clone this repo under **~/.config/awesome/** and then add widgets you'd like to use in wibox:
```bash
cd ~/.config/awesome/
git clone https://github.com/streetturtle/awesome-wm-widgets.git
```
and in **rc.lua**
```lua
require("awesome-wm-widgets.battery-widget.battery")
...
-- Add widgets to the wibox
s.mywibox:setup {
layout = wibox.layout.align.horizontal,
{ -- Left widgets
...
},
s.mytasklist, -- Middle widget
{ -- Right widgets
...
battery_widget,
...
}
```
# Icons
2017-06-22 02:53:48 +02:00
If you don't want to install Arc icon theme you can just download the icons which are used from the [Arc repository](https://github.com/horst3180/arc-theme).
2017-09-11 21:05:04 +02:00
Or create your own icons with the same name.
2017-02-05 19:18:06 +01:00
2017-02-02 03:25:25 +01:00
In case of any questions/suggestions don't hesitate to contact me, I would be happy to help :)
2017-02-02 02:59:04 +01:00
2017-05-29 19:14:37 +02:00
PRs/issues and st★rs are welcome!