Skip to content

Commit f308f18

Browse files
committed
Document pre-built binary runtime prerequisites
Spell out macOS dyld requirements (flac, libvorbis, libogg) and hoist the ffmpeg/yt-dlp runtime deps so they apply to all install methods, not just building from source. Addresses #191.
1 parent a78f5ce commit f308f18

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ curl -fsSL https://raw.githubusercontent.com/bjarneo/cliamp/HEAD/install.sh | sh
3434
brew install bjarneo/cliamp/cliamp
3535
```
3636

37+
The formula pulls in all required runtime libraries automatically.
38+
3739
**Arch Linux (AUR)**
3840

3941
```sh
@@ -44,6 +46,28 @@ yay -S cliamp
4446

4547
Download from [GitHub Releases](https://github.com/bjarneo/cliamp/releases/latest).
4648

49+
> **macOS:** the pre-built binaries dynamically link against FLAC, Vorbis, and Ogg
50+
> from Homebrew. If you download directly from Releases (or use the `install.sh`
51+
> script) you must install them first, otherwise you will see errors like
52+
> `Library not loaded: /opt/homebrew/opt/libvorbis/lib/libvorbisenc.2.dylib`:
53+
>
54+
> ```sh
55+
> brew install flac libvorbis libogg
56+
> ```
57+
>
58+
> Installing via `brew install bjarneo/cliamp/cliamp` does this for you.
59+
>
60+
> **Linux:** the pre-built binaries statically link FLAC, Vorbis, and Ogg, so no
61+
> extra codec packages are required. You may still need an ALSA bridge for your
62+
> sound server — see [Troubleshooting](#troubleshooting).
63+
64+
**Optional runtime dependencies** (all platforms, all install methods):
65+
66+
- [ffmpeg](https://ffmpeg.org/) — for AAC, ALAC, Opus, and WMA playback
67+
- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — for YouTube, YouTube Music, SoundCloud, Bandcamp, and Bilibili
68+
69+
On macOS: `brew install ffmpeg yt-dlp`. On Linux, use your distribution's package manager.
70+
4771
**Build from source**
4872
4973
```sh

0 commit comments

Comments
 (0)