Skip to content

Commit 0ec7127

Browse files
committed
docs: highlight Homebrew as the recommended install path
Reorders the install section so Homebrew (which auto-installs mpv and yt-dlp) is clearly the path of least resistance. Adds a note to the one-line installer pointing at the runtime-deps table since non-brew installs need mpv installed separately. Lifts the supported platforms line to the top of the section.
1 parent 8bd081d commit 0ec7127

2 files changed

Lines changed: 36 additions & 16 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,21 +55,31 @@ direct HTTP streams, and YouTube live/videos via `yt-dlp`).
5555

5656
## Install
5757

58-
### Homebrew (macOS, Linux)
58+
Supported platforms: `linux/amd64`, `linux/arm64`, `darwin/amd64`,
59+
`darwin/arm64`. Windows is not supported.
60+
61+
### Homebrew (macOS, Linux) — recommended
5962

6063
```sh
6164
brew install iRootPro/tap/lofi-player
6265
```
6366

67+
The formula pulls in `mpv` automatically and recommends `yt-dlp` for
68+
YouTube playback — one command and you're done.
69+
6470
### One-line installer (macOS, Linux)
6571

6672
```sh
6773
curl -fsSL https://raw.githubusercontent.com/iRootPro/lofi-player/main/scripts/install.sh | sh
6874
```
6975

70-
Drops the binary into `~/.local/bin` by default. Override with
71-
`INSTALL_DIR=/usr/local/bin` or pin to a specific tag with
72-
`VERSION=v0.1.0`.
76+
Auto-detects OS/arch, pulls the matching tarball from the latest
77+
release, drops the binary into `~/.local/bin`. Override with
78+
`INSTALL_DIR=/usr/local/bin` or pin to a tag with `VERSION=v0.1.1`.
79+
80+
You'll also need `mpv` (and optionally `yt-dlp`) — see
81+
[runtime dependencies](#runtime-dependencies) below. The installer
82+
prints a hint if `mpv` isn't on `$PATH`.
7383

7484
### From source (Go 1.26+)
7585

@@ -83,14 +93,14 @@ Grab the archive for your OS/arch from the
8393
[releases page](https://github.com/iRootPro/lofi-player/releases),
8494
extract, drop `lofi-player` somewhere on `$PATH`.
8595

86-
Supported platforms: `linux/amd64`, `linux/arm64`, `darwin/amd64`,
87-
`darwin/arm64`. Windows is not supported.
88-
8996
### Runtime dependencies
9097

98+
Homebrew handles these for you. The other install paths require you
99+
to install them separately.
100+
91101
| dependency | required for | install |
92102
|---|---|---|
93-
| `mpv` | all playback | `brew install mpv` · `apt install mpv` · `pacman -S mpv` |
103+
| `mpv` | all playback | `brew install mpv` · `apt install mpv` · `pacman -S mpv` · `dnf install mpv` |
94104
| `yt-dlp` | YouTube stations only | `brew install yt-dlp` · `pip install yt-dlp` |
95105
| Nerd Font | section/volume/mixer icons | [JetBrains Mono](https://github.com/ryanoasis/nerd-fonts/releases) or [FiraCode](https://github.com/ryanoasis/nerd-fonts/releases) Nerd Font |
96106

README.ru.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,31 @@ TUI-плеер для лофи, чиллхопа и эмбиент-радио
5959

6060
## Установка
6161

62-
### Homebrew (macOS, Linux)
62+
Поддерживаемые платформы: `linux/amd64`, `linux/arm64`,
63+
`darwin/amd64`, `darwin/arm64`. Windows не поддерживается.
64+
65+
### Homebrew (macOS, Linux) — рекомендую
6366

6467
```sh
6568
brew install iRootPro/tap/lofi-player
6669
```
6770

71+
Формула сама подтянет `mpv` и предложит `yt-dlp` для YouTube — одна
72+
команда и всё готово.
73+
6874
### Однострочный инсталлер (macOS, Linux)
6975

7076
```sh
7177
curl -fsSL https://raw.githubusercontent.com/iRootPro/lofi-player/main/scripts/install.sh | sh
7278
```
7379

74-
По умолчанию кладёт бинарник в `~/.local/bin`. Можно переопределить
75-
через `INSTALL_DIR=/usr/local/bin` или заПинить версию через
76-
`VERSION=v0.1.0`.
80+
Сам определяет OS/arch, скачивает архив из последнего релиза, кладёт
81+
бинарник в `~/.local/bin`. Переопределить можно через
82+
`INSTALL_DIR=/usr/local/bin`, заПинить версию — через `VERSION=v0.1.1`.
83+
84+
`mpv` (и опционально `yt-dlp`) поставь отдельно — см.
85+
[системные зависимости](#системные-зависимости) ниже. Инсталлер
86+
напишет подсказку если `mpv` не на `$PATH`.
7787

7888
### Из исходников (Go 1.26+)
7989

@@ -87,14 +97,14 @@ go install github.com/iRootPro/lofi-player@latest
8797
[страницы релизов](https://github.com/iRootPro/lofi-player/releases),
8898
распакуй, положи `lofi-player` куда-нибудь в `$PATH`.
8999

90-
Поддерживаемые платформы: `linux/amd64`, `linux/arm64`,
91-
`darwin/amd64`, `darwin/arm64`. Windows не поддерживается.
92-
93100
### Системные зависимости
94101

102+
Homebrew ставит их за тебя. Остальные пути установки требуют
103+
поставить руками.
104+
95105
| зависимость | для чего | установка |
96106
|---|---|---|
97-
| `mpv` | всё воспроизведение | `brew install mpv` · `apt install mpv` · `pacman -S mpv` |
107+
| `mpv` | всё воспроизведение | `brew install mpv` · `apt install mpv` · `pacman -S mpv` · `dnf install mpv` |
98108
| `yt-dlp` | только для YouTube-станций | `brew install yt-dlp` · `pip install yt-dlp` |
99109
| Nerd Font | иконки в шапке/громкости/микшере | [JetBrains Mono](https://github.com/ryanoasis/nerd-fonts/releases) или [FiraCode](https://github.com/ryanoasis/nerd-fonts/releases) Nerd Font |
100110

0 commit comments

Comments
 (0)