From 652e4eecf2098c4b171dcf55d858b7a9cbc8f08a Mon Sep 17 00:00:00 2001
From: Rafostar <40623528+Rafostar@users.noreply.github.com>
Date: Tue, 17 Nov 2020 15:06:53 +0100
Subject: [PATCH] Update README.md
---
README.md | 49 ++++++++-----------------------------------------
1 file changed, 8 insertions(+), 41 deletions(-)
diff --git a/README.md b/README.md
index 06599202..01e1bc40 100644
--- a/README.md
+++ b/README.md
@@ -20,36 +20,12 @@ A GNOME media player built using [GJS](https://gitlab.gnome.org/GNOME/gjs) and p
This is still early WIP. Many features are not implemented yet and quite a few are still unstable.
### Features:
-
- Playlists
-
-Clapper can open playlist files. Playlist file is a standard text file with a `.claps` file extension.
-It should contain a single filepath per line. The filepath can be either absolute or relative.
-Playlist can even contain HTTP links instead of filepaths.
-
-Here is an example how to easily create a playlist file inside your music directory:
-```shell
-ls *.mp3 > music.claps
-```
-Once you have a playlist, open it with Clapper like any other file.
-Since the playlist is a normal text file with filepaths only, you can always edit it later in any text editor or `echo` more media to it. Easy, right?
-
-
-
- Hardware acceleration
-
-Using hardware acceleration is highly recommended. As stated in `GStreamer` wiki:
-```
-In the case of OpenGL based elements, the buffers have the GstVideoGLTextureUploadMeta meta, which
-efficiently copies the content of the VA-API surface into a GL texture.
-```
-Clapper uses `OpenGL` based sinks, so when `VA-API` is available, both CPU and RAM usage is much lower. Especially with `gst-plugins-bad` 1.18+ and new `vah264dec` decoder which shares a single GL context with Clapper and uses DRM connection. If you have an AMD/Intel GPU and use Wayland session, I highly recommend enabling this new decoder in Clapper `Preferences->Advanced->GStreamer`.
-
-Other acceleration methods (supported by `GStreamer`) should also work, but I have not tested them due to lack of hardware.
-
+* [Playlists](https://github.com/Rafostar/clapper/wiki/Playlists)
+* [Hardware acceleration](https://github.com/Rafostar/clapper/wiki/Hardware-acceleration)
+* [Floating mode](https://github.com/Rafostar/clapper/wiki/Floating-mode)
## Installation from flatpak (recommended)
-The flatpak package includes all required dependencies and codecs. Additionally it also has a few patches, thus some funcionalities work better (or are only available) on flatpak version (until my changes are accepted upstream).
+The flatpak package includes all required dependencies and codecs. Additionally it also has a few patches, thus some functionalities work better (or are only available) in flatpak version (until my changes are accepted upstream).
```sh
flatpak install https://rafostar.github.io/flatpak/com.github.rafostar.Clapper.flatpakref
@@ -57,21 +33,12 @@ flatpak install https://rafostar.github.io/flatpak/com.github.rafostar.Clapper.f
## Packages
The [pkgs folder](https://github.com/Rafostar/clapper/tree/master/pkgs) in this repository contains build scripts for various package formats. You can use them to build package yourself or download one of pre-built packages:
-
- Debian, Fedora, openSUSE & Ubuntu
-
-Pre-built packages are available in [my repo](https://software.opensuse.org//download.html?project=home%3ARafostar&package=clapper) ([see status](https://build.opensuse.org/package/show/home:Rafostar/clapper))
-
-
-Arch Linux
+#### Debian, Fedora, openSUSE & Ubuntu
+Pre-built packages are available in [my repo](https://software.opensuse.org//download.html?project=home%3ARafostar&package=clapper) ([see status](https://build.opensuse.org/package/show/home:Rafostar/clapper)).
-You can get Clapper from the AUR: [clapper-git](https://aur.archlinux.org/packages/clapper-git), or
-```shell
-cd pkgs/arch
-makepkg -si
-```
-
+#### Arch Linux
+You can get Clapper from the AUR: [clapper-git](https://aur.archlinux.org/packages/clapper-git)
## Installation from source code
The requirements and how to build from git source code are described in the [wiki](https://github.com/Rafostar/clapper/wiki#installation-from-source-code).