diff options
| author | Leon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de> | 2020-09-26 13:18:32 +0200 |
|---|---|---|
| committer | Leon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de> | 2020-09-28 02:36:01 +0200 |
| commit | 646f6545b9405aae65812470ba518a9701295751 (patch) | |
| tree | 31458e10728b21d6b99c05a208b79773e873fb4f | |
| parent | 24e8ee33b509f71bbcaaffe83bd49eb144c2c1a7 (diff) | |
| download | wlclock-646f6545b9405aae65812470ba518a9701295751.tar.gz wlclock-646f6545b9405aae65812470ba518a9701295751.tar.bz2 | |
Update wording in README and man page
| -rw-r--r-- | README.md | 7 | ||||
| -rw-r--r-- | doc/wlclock.1.scd | 16 |
2 files changed, 15 insertions, 8 deletions
@@ -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. diff --git a/doc/wlclock.1.scd b/doc/wlclock.1.scd index 3bc1a21..05638df 100644 --- a/doc/wlclock.1.scd +++ b/doc/wlclock.1.scd @@ -7,13 +7,13 @@ wlclock - A digital analog clock for Wayland # DESCRIPTION wlclock displays an analog clock on 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. -wlclock is heavily inspired by xclock(1) and the default configuration has been -chosen to mimic xclock. However unlike xclock, wlclock is not a regular window -but a desktop-widget. - # OPTIONS *-h*, *--help* Display help message and exit. @@ -39,10 +39,10 @@ but a desktop-widget. The colour of clock elements. The default is "#000000". *--corner-radius* <radius>, *--corner-radius* <top-left> <top-right> <bottom-right> <bottom-left> - The radius of the corners. Expects either one argument, to set the radius of - all corners, or four arguments, to set the individual corner radii. The - default radius is 5. If set to sufficiently high values, wlclock will be - completely round. Set to 0 to disable corner roundness. + The radius of the corners. Expects either one argument, to set the radius + of all corners, or four arguments, to set the individual corner radii. If + set to sufficiently high values, wlclock will be completely round. Set to 0 + to disable corner roundness. The default radius is 0. *--exclusive-zone* <option> Exclusive zone of the surface. Can be "true", "false" or "stationary". If |