Update the README

This commit is contained in:
Gergely Polonkai 2022-05-19 10:29:27 +02:00
parent ac95404017
commit bede824603
No known key found for this signature in database
GPG Key ID: 2D2885533B869ED4

View File

@ -1,3 +1,44 @@
# Seasonal Hours Clock on Wayland # Seasonal Hours Clock on Wayland
This is a Rust implementation of cinnamons [Seasonal Hours Clock](https://github.com/cinnamon-bun/seasonal-hours-clock), running as a native Wayland application. This is a Rust implementation of cinnamons [Seasonal Hours Clock](https://github.com/cinnamon-bun/seasonal-hours-clock), running as a native Wayland application.
## Features
### Seasonal hours!
In cinnamons words:
> t would be nice if the 24 hours of UTC time each had a short memorable name. It would make it easier to plan chats with distant friends, since the hour-names would be synchronized around the world.
>
> Let's choose a theme like... seasons of the year, just to be confusing. :) Squish a year into 24 hours starting with the winter solstice at UTC 00, which we'll call The Candle Hour.
The seasonal hour names are shown on the colourful ring. Seasons are colour-coded: winter is blue, spring is green, summer is yellow, autumn is brownish/orange.
### Local time
Its shown on the outermost ring, and as a standard watch. Currently its 24h only, but AM/PM version is in the works.
### UTC hours
Just so you can connect the hour names to actual numbers and to help you with inter-timezone planning. These are shown in the inner ring with a bit fainter numbers.
### Day parts
The coloured pie chart in the middle shows
- night time (very dark grey)
- pre-dawn/post-dusk time (dark blue)
- the golden hour (golden)
- daytime (bright blue)
The small red handles show the solar noon and midnight (nadir) times.
The hour hand shows the current time; the golden disc, visible only during daytime, shows the Suns position on the sky.
### Moon phase
The innermost circle is the current Moon phase. It tries to be as realistic as possible.
## Limitations
The day parts dont work well (or sometimes they dont work at all) around and beyond the arctic lines: i havent found a reliable way to differentiate between all-day daytime and all-day nighttime.