summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de>2020-09-26 13:18:32 +0200
committerLeon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de>2020-09-28 02:36:01 +0200
commit646f6545b9405aae65812470ba518a9701295751 (patch)
tree31458e10728b21d6b99c05a208b79773e873fb4f /README.md
parent24e8ee33b509f71bbcaaffe83bd49eb144c2c1a7 (diff)
downloadwlclock-646f6545b9405aae65812470ba518a9701295751.tar.gz
wlclock-646f6545b9405aae65812470ba518a9701295751.tar.bz2
Update wording in README and man page
Diffstat (limited to '')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 84a3bcd..aac7f99 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,12 @@
wlclock is a digital analog clock for Wayland desktops.
+wlclock is inspired by xclock(1) and the default configuration has been chosen
+to mimic it. However unlike xclock, wlclock is not a regular window but a
+desktop-widget.
+
+A Wayland compositor must implement the Layer-Shell and XDG-Output for wlclock
+to work.
## Building
@@ -18,6 +24,7 @@ and `scdoc` to generate the manpage.
## Contributing
+
**Contributions are welcome!** Read `CONTRIBUTING.md` to find out how you can
contribute. Do not be afraid, it is really not that complicated.