Change README to markdown format.r14.0.11

Add translation status overview.

Signed-off-by: Slávek Banko <[email protected]>
(cherry picked from commit c6abc811ce70d14214b038be0371de493307b41c)

1 files changed, 57 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6ce860e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+KBiff - a biff utility.
+
+Kbiff is a "xbiff like" mail notification utility for TDE.
+
+
+It has  multiple pixmaps, session management and GUI configuration.
+It can "dock" into the TDE panel. It can display animated gifs, play
+system sounds or run arbitrary shell command when new mail arrives.
+
+
+It is highly configurable but very easy to use and setup. It tries
+to combine the best or at least "all" of the features of most of the
+other "biff" programs out there, namely:
+
+* Pure GUI configuration. No command line parameters or strange config
+  files. All settings for KBiff can be done from one setup dialog.
+
+* Session management. KBiff starts up with the same configuration you
+  left it with.
+
+* Panel docking. KBiff can be docked into the panel very easily. Handy
+  when you are monitoring several mailboxes and don't have the room
+  anywhere else.
+
+* System sounds. KBiff can play most audio files when new mail arrives.
+
+* Animated gifs. KBiff can handle GIF89 animated gifs.
+
+* It supports mbox, maildir, mh, POP3(S), IMAP4(S) and NNTP mailboxes.
+
+* Highly configurable. There are very few things in KBiff that you
+  have to accept. Most things can be changed to fit your needs.
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to KBiff (TDE), you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/weblate
+
+
+Translations status
+---------------------
+
+### messages
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kbiff/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kbiff/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kbiff-kbiffdesktop/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kbiff-kbiffdesktop/)