nixos/home-modules/explicit-configs/awesome/deficient/calendar/README.md

37 lines
903 B
Markdown
Raw Normal View History

2025-05-03 23:42:03 -07:00
## awesome-calendar
Small calendar popup for awesome window manager.
![Screenshot](/calendar/screenshot.png?raw=true "Screenshot")
This is a polished up and improved module based on the `calendar2.lua` module
by Bernd Zeimetz and Marc Dequènes.
### Usage
In your `rc.lua`:
```lua
local deficient = require("deficient")
-- instanciate widget
local calendar_widget = deficient.calendar({})
-- attach it as popup to your text clock widget
calendar_widget:attach(mytextclock)
```
You can also add some options to customize the widget's display. For instance:
```
calendar_widget = deficient.calendar({
fdow = 7, -- Set Sunday as first day of the week (default is
-- 1 = Monday)
position = "bottom_right", -- Useful if you prefer your wibox at the bottomn
-- of the screen
})
calendar_widget:attach(mytextclock)
```