From f0ce1160fdd2a513d51916f02c6bd2df0b6c6181 Mon Sep 17 00:00:00 2001 From: Robin Krens <robin@robinkrens.nl> Date: Wed, 25 Nov 2020 16:41:34 +0100 Subject: [PATCH] cleanup and readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fa9a7f --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +## KDE Plasmoid Let it snow + +Let it snow on your desktop! This widget works like an overlay: snow flakes will +always be on top and continue to fall, no matter what you are doing! + +Support: +* Size, speed, count and style can be changed dynamically + +Implementation details: +* Uses special flags of X11 +* Just QML; no additional install instructions required +* Since MouseEvents can't be masked with QML this implementation +is a bit different than what is possible with a QT C++ plugin. + +I welcome user art for cooler and better snow flakes! + +I also welcome ideas for tweaking parameters. There is a lot, i.e. falling +speed, speed rotation, direction, swirling speed of snow flakes, opacity, random +size calculation, etc... + +In case there is interest, I can make a more efficient implememtation in C++. + +### Install +Should be installable through the KDE Store +You can also copy this repository in ./local/share/plasma/plasmoids/ + +Here are some screenshots: + + + +Classic mode + + + +Different snow flake, smaller average size -- 2.7.4