awesome-wm-widgets/word-clock-widget
pingarelho 4768d48a3b Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
..
screenshots [word-clock] add screenshot to readme 2020-11-26 13:28:49 -05:00
README.md Fix documentation inconsistencies (mainly tables) 2023-09-20 23:01:55 +01:00
word-clock.lua fix few issues 2020-12-02 09:18:16 -05:00

README.md

word clock widget

Widget displaying current time using words:

screenshot

Customization

It is possible to customize widget by providing a table with all or some of the following config parameters:

Name Default Description
main_color beautiful.fg_normal Color of the word on odd position
accent_color beautiful.fg_urgent Color of the word on even position
font beautiful.font Font (Play 20)
is_human_readable false nine fifteen or fifteen past nine
military_time false 12 or 24 time format
with_spaces false Separate words with spaces

Installation

Clone repo, include widget and use it in rc.lua:

local word_clock = require("awesome-wm-widgets.word-clock-widget.word-clock")
...
s.mytasklist, -- Middle widget
	{ -- Right widgets
    	layout = wibox.layout.fixed.horizontal,
		...
		word_clock(),		
	...

Screenshots

 word_clock{
    font = 'Carter One 12',
    accent_color = '#ff79c6',
    main_color = '#8be9fd',
    is_human_readable = true,
}

word_clock{
    font = 'Carter One 12',
    is_human_readable = true,
}

word_clock{
    font = 'Carter One 12',
    is_human_readable = true,
    military_time = true
}

word_clock{
    font = 'Carter One 12',
    accent_color = '#f00',
    main_color = '#0f0',
}