diff options
author | Bastien Nocera <hadess@hadess.net> | 2023-01-25 16:50:35 +0100 |
---|---|---|
committer | Bastien Nocera <hadess@hadess.net> | 2023-01-25 16:54:20 +0100 |
commit | 9ad2be78e1629a0e3a711fa41fc6b94993dd3d95 (patch) | |
tree | 7b9a3f4ba92e3a5d65be938ca5d6a118b64a252d | |
parent | fabe4f75d338c17d94de9179dea72b9304bcfe1a (diff) | |
download | totem-9ad2be78e1629a0e3a711fa41fc6b94993dd3d95.tar.gz |
README: Update README
Mention that only the Flathub release is supported, update layout and
information.
-rw-r--r-- | README | 71 | ||||
-rw-r--r-- | README.md | 55 |
2 files changed, 55 insertions, 71 deletions
diff --git a/README b/README deleted file mode 100644 index 4ab0a8eaa..000000000 --- a/README +++ /dev/null @@ -1,71 +0,0 @@ - - _|_ __|_ _ ._ _ - |_(_)|_(/_| | | - -Totem is movie player for the GNOME desktop based on GStreamer. -It features a playlist, a full-screen mode, seek and volume controls, -as well as complete keyboard navigation. - -Apart from a movie player, it also includes a video thumbnailer. - -News -==== - -See NEWS file - -Dependencies -============ - -GStreamer 1.0 - http://gstreamer.freedesktop.org - -GNOME 3.x development platform - http://www.gnome.org - -Controls -======== - -Ctrl+H: - Shortcut help - -Undocumented shortcuts: -M (when playing a DVD): - Menu -Ctrl+Q: - Quit -Ctrl+W: - Press back button/Quit -Mouse button 1 double-click: - Toggle full screen -Middle mouse button click: - Play/Pause - -Copyright -========= - -Nifty media player icon by Jakub Steiner <jimmac@ximian.com> - -UI help by Seth Nickell <snickell@stanford.edu> - -Automatic GStreamer codec installation (optional) -================================================================ -- calls (via GStreamer) a predefined external helper script (which is to be - installed by the distro and can be defined via gst-plugins-base's configure - script when building gst-plugins-base) with details of missing GStreamer - plugins. For more information on how this all works together see - https://gstreamer.freedesktop.org/documentation/pbutils/gstpbutilsinstallplugins.html - -BUGS -==== - -Bugs should be filed in GNOME's GitLab: -https://gitlab.gnome.org/GNOME/totem/issues/ - -To get a better debug output, follow the instructions at: -https://wiki.gnome.org/Apps/Videos/Contribute - -Contact -======= - -Bastien Nocera <hadess@hadess.net> -http://wiki.gnome.org/Apps/Videos diff --git a/README.md b/README.md new file mode 100644 index 000000000..29db67c0e --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +![icon](data/icons/scalable/org.gnome.Totem.svg) + +# Videos +Videos is movie player for the GNOME desktop based on [GStreamer](https://gstreamer.freedesktop.org/). + +[![Download on Flathub](https://upload.wikimedia.org/wikipedia/commons/thumb/a/a6/Flathub-badge-en.svg/240px-Flathub-badge-en.svg.png)](https://flathub.org/apps/details/org.gnome.Totem) + +## Support +========== + +The only version of totem that's supported is the one shipped on Flathub. +**Do not file bugs that don't happen with the Flathub version**. + +If the problem still occurs with the Flathub version, please test the +Development version which can be installed with this command: + +``` +flatpak install --user https://flathub.org/beta-repo/appstream/org.gnome.Totem.Devel.flatpakref +``` + +See below for details about how to file bugs. + +## Dependencies +=============== + +- [GStreamer 1.6](http://gstreamer.freedesktop.org) +- [GNOME 3.x development platform](http://www.gnome.org) + +## Controls +=========== + +Almost all the controls are documented in the keyboard shortcuts dialogue, +accessible through `Ctrl+H`, or the *Keyboard Shortcuts* menu item. Some others +are listed in the table below. + +| Function | Shortcut | +| :--- | :--- | +| `M` (when playing a DVD) | menu | +| `Ctrl+Q` | Quit | +| `Ctrl+W` | Press back button/Quit | +| `Mouse button 1 double-click` | Toggle full screen | +| `Middle mouse button click` | Play/Pause | + +## Copyright + +- Nifty media player icon by [Jakub Steiner](https://gitlab.gnome.org/jimmac) +- UI help by Seth Nickell and William Jon McCann +- For code copyright, see the [COPYING file](COPYING) + +## Bugs + +Bugs should be filed in the [GNOME GitLab](https://gitlab.gnome.org/GNOME/totem/issues/). + +If the problem happens with a single video, please make sure to share it either +through the issue tracker, or through a third-party service if the file is too big.
\ No newline at end of file |