summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2019-12-12 22:39:16 -0500
committerstreetturtle <streetturtle@gmail.com>2019-12-12 22:39:16 -0500
commit8fea20806e7735a5d480a9a69b9b7966b2f5f2e4 (patch)
tree2f58d6a0ae77aae6262d17f050eaa93e21564f6f
parente8f79dccee3db6b058463253197de9f2d1b74bea (diff)
add readme for the calendar widget
-rw-r--r--calendar-widget/README.md28
-rw-r--r--calendar-widget/calendar_top.pngbin0 -> 65350 bytes
-rw-r--r--calendar-widget/calendar_top_right.pngbin0 -> 133425 bytes
3 files changed, 28 insertions, 0 deletions
diff --git a/calendar-widget/README.md b/calendar-widget/README.md
new file mode 100644
index 0000000..a7d1561
--- /dev/null
+++ b/calendar-widget/README.md
@@ -0,0 +1,28 @@
+# Calendar Widget
+
+Calendar widget for Awesome WM - slightly improved version of the `wibox.widget.calendar`. Also supports mouse scroll up/down in order ot switch month - scroll up - shows next month, scroll down - previous.
+
+Top center placement:
+
+![calendar_top](./calendar_top.png)
+
+Top right placement:
+
+![calendar_top_right](./calendar_top_right.png)
+
+The placement is setup in theme.lua by `calendar_placement` variable, currently supported `top` (default), `top_right`, `bottom_right`.
+
+# How to use
+
+This widget need an 'anchor' - another widget which triggers visibility of the calendar. Default `mytextclock` is the perfect candidate!
+
+```lua
+local calendar_widget = require("awesome-wm-widgets.calendar-widget.calendar")
+-- ...
+-- Create a textclock widget
+mytextclock = wibox.widget.textclock()
+mytextclock:connect_signal("button::press",
+ function(_, _, _, button)
+ if button == 1 then calendar_widget.toggle() end
+ end)
+``` \ No newline at end of file
diff --git a/calendar-widget/calendar_top.png b/calendar-widget/calendar_top.png
new file mode 100644
index 0000000..3e6b66b
--- /dev/null
+++ b/calendar-widget/calendar_top.png
Binary files differ
diff --git a/calendar-widget/calendar_top_right.png b/calendar-widget/calendar_top_right.png
new file mode 100644
index 0000000..4a29022
--- /dev/null
+++ b/calendar-widget/calendar_top_right.png
Binary files differ