summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2021-10-19 19:25:44 +0200
committerSlávek Banko <slavek.banko@axis.cz>2021-10-19 19:25:44 +0200
commit87d4347fbef1eb34aa160147cc84d6df586d4157 (patch)
tree61dc79d854f427c4766dd41f78402a13eb4562a9 /README.md
parent3709cf782acd52868399952907a99b82eca8ca12 (diff)
downloadkmplayer-87d4347fbef1eb34aa160147cc84d6df586d4157.tar.gz
kmplayer-87d4347fbef1eb34aa160147cc84d6df586d4157.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.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb8de1f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+
+ KMPlayer - a simple media player for TDE.
+
+
+KMPlayer is a GUI for several backends, namely:
+
+- Mplayer
+- Xine
+- Gstreamer
+- ffmpeg
+
+It can play DVD/VCD movies, from file or url and from a video device.
+
+
+Features:
+---------
+
+* can act as a browser plugin for Konqueror
+* can embed into a KOffice document.
+* play DVD (DVDNav only with the Xine player)
+* play VCD
+* let the backend players play from a pipe (read from stdin)
+* play from a TV device (experimental)
+* show backend player's console output
+* launch ffserver when viewing from a v4l device
+* DCOP KMediaPlayer interface support
+* VDR viewer frontend (with *kxvplayer), configure VDR keys with standard TDE
+ shortcut configure window
+* Lots of configurable shortcuts. Highly recommended for the VDR keys
+ and volume increase/decrease
+* Broadcaste http streaming by using ffserver/ffmpeg
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to kmplayer, 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/-/kmplayer/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kmplayer/)
+
+### desktop files
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kmplayer-desktop-files/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kmplayer-desktop-files/)