From 840b1663e7c1843adb7d9878c39f29ad28239b64 Mon Sep 17 00:00:00 2001 From: talwat <83217276+talwat@users.noreply.github.com> Date: Tue, 18 Feb 2025 21:25:30 +0200 Subject: [PATCH] docs: tweak control documentation --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 746d8ff..88334c9 100644 --- a/README.md +++ b/README.md @@ -102,17 +102,23 @@ Yeah, that's it. ### Controls -| Key | Function | -|--------------|-----------------| -| `s\|n\|l` | Skip song | -| `p\| ` | Play/Pause | -| `+\|=\|k\|↑` | Volume Up 10% | -| `→` | 1% | -| `-\|_\|j\|↓` | Volume Down 10% | -| `←` | 1% | -| `q\|ctrl+c` | Quit | +| Key | Function | +| ------------------ | --------------- | +| `s`, `n`, `l` | Skip Song | +| `p` | Play/Pause | +| `+`, `=`, `k`, `↑` | Volume Up 10% | +| `→` | Volume Up 1% | +| `-`, `_`, `j`, `↓` | Volume Down 10% | +| `←` | Volume Down 1% | +| `q`, CTRL+C | Quit | -Besides its regular controls, lowfi offers compatibility with Media Keys and [MPRIS](https://wiki.archlinux.org/title/MPRIS) (with tools like `playerctl`) +> [!NOTE] +> Besides its regular controls, lowfi offers compatibility with Media Keys +> and [MPRIS](https://wiki.archlinux.org/title/MPRIS) (with tools like `playerctl`) +> +> MPRIS is currently optional feature in cargo (enabled with `--features mpris`) +> due to it being only for Linux, as well as the fact that the main point of +> lowfi is it's unique & minimal interface. ### Extra Flags @@ -182,8 +188,8 @@ lowfi would download these three URLs: Additionally, you may also specify a custom display name for the track which is indicated by a `!`. For example, if you had an entry like this: -``` +```txt 2023/04/2-In-Front-Of-Me.mp3!custom name ``` -Then lowfi would download from the first section, and display the second. \ No newline at end of file +Then lowfi would download from the first section, and display the second.