summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2021-10-19 12:56:28 +0200
committerSlávek Banko <slavek.banko@axis.cz>2021-10-19 12:56:28 +0200
commit887dc12fcc591028886575ea0b783b6e9c5742c2 (patch)
tree1cd929969150d89979a9a6111768133e7dcc2643 /README.md
parent06c5319ab17455a7344a54cd1c4971dcaea7a3f4 (diff)
downloadkshowmail-887dc12fcc591028886575ea0b783b6e9c5742c2.tar.gz
kshowmail-887dc12fcc591028886575ea0b783b6e9c5742c2.zip
Change README to markdown format.
Add translation status overview. Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..235848a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+
+ kshowmail - an email viewer for TDE.
+
+
+Kshowmail display emails from a POP3 email server without actually
+downloading them.
+The headers or the complete emails can be viewed and unwanted emails can
+be deleted. An initial and an interval timer can be set to check the
+emails periodical.
+
+
+Features:
+---------
+
+* supports multiple accounts
+* timers
+* filters for spam
+* sounds can be played if new email arrives
+* a command menu allows commands like fetchmail or sendmail
+* a command can be defined to send complain email against spam
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to kshowmail, 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/-/kshowmail/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kshowmail/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kshowmail-desktop-files/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kshowmail-desktop-files/)