summaryrefslogtreecommitdiff
path: root/README.md
blob: 3a97cea4490d5cf83b82890015d0fdd382a12910 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# AwesomeWM

Set of super simple widgets compatible with Awesome Window Manager v.4.

![screenshot](https://github.com/streetturtle/AwesomeWM/blob/master/screenshot.png?raw=true)

From left to right:

- [spotify-widget](https://github.com/streetturtle/AwesomeWM/tree/master/spotify-widget) / [rhythmbox-widget](https://github.com/streetturtle/AwesomeWM/tree/master/rhythmbox-widget)
- [weather-widget](https://github.com/streetturtle/AwesomeWM/tree/master/weather-widget)
- [email-widget](https://github.com/streetturtle/AwesomeWM/tree/master/email-widget)
- [brightness-widget](https://github.com/streetturtle/AwesomeWM/tree/master/brightness-widget)
- [volume-widget](https://github.com/streetturtle/AwesomeWM/tree/master/volume-widget)
- [battery-widget](https://github.com/streetturtle/AwesomeWM/tree/master/battery-widget)
- [volumebar-widget](https://github.com/streetturtle/AwesomeWM/tree/master/volumebar-widget) (not on the screenshot)

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:

```lua
...
sprtr = wibox.widget.textbox()
sprtr:set_text(" : ")
...
sprtr,
volume_icon,
sprtr,
battery_widget,
sprtr,
...
```

# Installation

[Install](https://github.com/horst3180/arc-icon-theme#installation) Arc icon theme and follow installation instructions of each widget.

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

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).
Or create your own icons with the same name. Here is the list of icons used:

<table>
  <tr>
    <th>Widget</th>
    <th>Icon name</th>
    <th>Arc Path</th>
  </tr>
  <tr>
    <td rowspan="2">email-widget</td>
    <td>mail-message-new.png<br></td>
    <td rowspan="2">/usr/share/icons/Arc/actions/22/</td>
  </tr>
  <tr>
    <td>mail-mark-unread.png</td>
    <td></td>
  </tr>
  <tr>
    <td>brightness-widget</td>
    <td>display-brightness-symbolic.svg</td>
    <td>/usr/share/icons/Arc/status/symbolic/</td>
  </tr>
  <tr>
    <td rowspan="4">volume-widget</td>
    <td>audio-volume-muted-symbolic.svg</td>
    <td rowspan="4">/usr/share/icons/Arc/status/symbolic/</td>
  </tr>
  <tr>
    <td>audio-volume-low-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>audio-volume-medium-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>audio-volume-high-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td rowspan="8">battery-widget</td>
    <td>battery-caution-symbolic.svg</td>
    <td rowspan="8">/usr/share/icons/Arc/status/symbolic/</td>
  </tr>
  <tr>
    <td>battery-caution-charging-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>battery-low-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>battery-low-charging-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>battery-good-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>battery-good-charging-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>battery-full-symbolic.svg</td>
    <td></td>
  </tr>
  <tr>
    <td>battery-full-charging-symbolic.svg</td>
    <td></td>
  </tr>
</table>

In case of any questions/suggestions don't hesitate to contact me, I would be happy to help :)

PRs/issues and st★rs are welcome!