From 373dad55251fad355ed25b2c9d728b4c7446fb10 Mon Sep 17 00:00:00 2001 From: wehub-resource-sync Date: Mon, 13 Jul 2026 10:21:14 +0000 Subject: [PATCH] docs: make Chinese README the default --- README.md | 149 +++++++++++++++++++++++++++--------------------------- 1 file changed, 74 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 8478f66..cc1ce1c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,20 @@ -A retro terminal music player inspired by Winamp. Play local files, streams, podcasts, YouTube, YouTube Music, SoundCloud, Bilibili, Spotify, NetEase Cloud Music, Xiaoyuzhou (小宇宙), Navidrome, Plex, and Jellyfin with a spectrum visualizer, parametric EQ, and playlist management. + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/bjarneo/cliamp) · [上游 README](https://github.com/bjarneo/cliamp/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + +一款受 Winamp 启发的复古终端音乐播放器。可播放本地文件、流媒体、播客，以及 YouTube、YouTube Music、SoundCloud、Bilibili、Spotify、网易云音乐（NetEase Cloud Music）、小宇宙（Xiaoyuzhou）、Navidrome、Plex 和 Jellyfin，并配有频谱可视化器、参数均衡器（parametric EQ）和播放列表管理功能。 **[cliamp.stream](https://cliamp.stream)** -Built with [Bubbletea](https://github.com/charmbracelet/bubbletea), [Lip Gloss](https://github.com/charmbracelet/lipgloss), [Beep](https://github.com/gopxl/beep), and [go-librespot](https://github.com/devgianlu/go-librespot). +基于 [Bubbletea](https://github.com/charmbracelet/bubbletea), [Lip Gloss](https://github.com/charmbracelet/lipgloss), [Beep](https://github.com/gopxl/beep), 与 [go-librespot](https://github.com/devgianlu/go-librespot). 构建 https://github.com/user-attachments/assets/fbc33d20-e3ac-4a62-a991-8a2f0243c8ea -## Install +## 安装 ```sh curl -fsSL https://raw.githubusercontent.com/bjarneo/cliamp/HEAD/install.sh | sh @@ -20,7 +26,7 @@ curl -fsSL https://raw.githubusercontent.com/bjarneo/cliamp/HEAD/install.sh | sh brew install bjarneo/cliamp/cliamp ``` -The formula pulls in all required runtime libraries automatically. +该 formula 会自动拉取所有必需的运行时库。 **Arch Linux (AUR)** @@ -34,47 +40,40 @@ yay -S cliamp go install github.com/bjarneo/cliamp@latest ``` -Linux builds need ALSA development headers installed first. See [Building from source](#building-from-source). +Linux 构建需先安装 ALSA 开发头文件。请参阅[从源码构建](#building-from-source)。 -**Pre-built binaries** +**预编译二进制文件** -Download from [GitHub Releases](https://github.com/bjarneo/cliamp/releases/latest). +从 [GitHub Releases](https://github.com/bjarneo/cliamp/releases/latest). 下载 -> **macOS:** the pre-built binaries dynamically link against FLAC, Vorbis, and Ogg -> from Homebrew. If you download directly from Releases (or use the `install.sh` -> script) you must install them first, otherwise you will see errors like -> `Library not loaded: /opt/homebrew/opt/libvorbis/lib/libvorbisenc.2.dylib`: +> **macOS：** 预编译二进制文件会通过 Homebrew 动态链接 FLAC、Vorbis 和 Ogg。若直接从 Releases 下载（或使用 `install.sh` 脚本），须先安装这些库，否则会出现类似 `Library not loaded: /opt/homebrew/opt/libvorbis/lib/libvorbisenc.2.dylib` 的错误： > > ```sh > brew install flac libvorbis libogg > ``` > -> Installing via `brew install bjarneo/cliamp/cliamp` does this for you. +> 通过 `brew install bjarneo/cliamp/cliamp` 安装可自动完成上述步骤。 > -> **Linux:** the pre-built binaries statically link FLAC, Vorbis, and Ogg, so no -> extra codec packages are required. You may still need an ALSA bridge for your -> sound server — see [Troubleshooting](#troubleshooting). +> **Linux：** 预编译二进制文件静态链接 FLAC、Vorbis 和 Ogg，因此无需额外安装编解码器包。你可能仍需要为声音服务器配置 ALSA 桥接——请参阅[故障排除](#troubleshooting)。 > -> **Windows:** download `cliamp-windows-amd64.exe` from Releases. If `HOME` is not -> set, cliamp stores its config under `%APPDATA%\cliamp`. The Spotify provider is -> currently unavailable on Windows builds. +> **Windows：** 从 Releases 下载 `cliamp-windows-amd64.exe`。若未设置 `HOME`，cliamp 会将配置保存在 `%APPDATA%\cliamp` 下。Windows 构建目前不支持 Spotify 提供商。 -**Optional runtime dependencies** (all platforms, all install methods): +**可选运行时依赖**（全平台、所有安装方式均适用）： -- [ffmpeg](https://ffmpeg.org/) — for AAC, ALAC, Opus, and WMA playback -- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — for YouTube, YouTube Music, SoundCloud, Bandcamp, Bilibili, and NetEase Cloud Music +- [ffmpeg](https://ffmpeg.org/) — 用于播放 AAC、ALAC、Opus 和 WMA +- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — 用于 YouTube、YouTube Music、SoundCloud、Bandcamp、Bilibili 和网易云音乐 -On macOS: `brew install ffmpeg yt-dlp`. On Linux, use your distribution's package manager. +在 macOS 上：`brew install ffmpeg yt-dlp`。在 Linux 上，请使用发行版的包管理器。 -On Windows, install `ffmpeg` and `yt-dlp` with your preferred package manager and keep both on `PATH`. +在 Windows 上，请通过你偏好的包管理器安装 `ffmpeg` 和 `yt-dlp`，并确保二者均位于 `PATH`。 -**Build from source** +**从源码构建** ```sh git clone https://github.com/bjarneo/cliamp.git && cd cliamp && go build -o cliamp . ``` -## Quick Start +## 快速开始 ```sh cliamp ~/Music # play a directory @@ -82,54 +81,54 @@ cliamp *.mp3 *.flac # play files cliamp https://example.com/stream # play a URL ``` -Press `Ctrl+K` to see all keybindings. +按 `Ctrl+K` 可查看所有按键绑定。 -**Configure remote providers** (Navidrome, Plex, Jellyfin, Spotify, YouTube Music, NetEase Cloud Music) with the interactive wizard: +**配置远程提供商**（Navidrome、Plex、Jellyfin、Spotify、YouTube Music、网易云音乐）可使用交互式向导进行配置： ```sh cliamp setup ``` -It walks you through each provider, validates the connection, and writes the right block to your config file (`~/.config/cliamp/config.toml`, or `%APPDATA%\cliamp\config.toml` on Windows when `HOME` is unset). See [docs/cli.md](docs/cli.md#setup-wizard) for details. +向导会逐步引导你配置各提供商，验证连接，并将相应配置块写入配置文件（`~/.config/cliamp/config.toml`；在 Windows 上若未设置 `HOME`，则为 `%APPDATA%\cliamp\config.toml`）。详见 [docs/cli.md](docs/cli.md#setup-wizard)。 -## Radio +## 电台 -Press `R` in the player to browse and search 30,000+ online radio stations from the [Radio Browser](https://www.radio-browser.info/) directory. +在播放器中按 `R`，可浏览并搜索来自 [Radio Browser](https://www.radio-browser.info/) 目录的 30,000+ 个在线电台。 -Add your own stations to `~/.config/cliamp/radios.toml` (or `%APPDATA%\cliamp\radios.toml` on Windows when `HOME` is unset). See [docs/configuration.md](docs/configuration.md#custom-radio-stations). +将自定义电台添加到 `~/.config/cliamp/radios.toml`（在 Windows 上若未设置 `HOME`，则使用 `%APPDATA%\cliamp\radios.toml`）。详见 [docs/configuration.md](docs/configuration.md#custom-radio-stations)。 -Want to host your own radio? Check out [cliamp-server](https://github.com/bjarneo/cliamp-server). +想自建电台？可查看 [cliamp-server](https://github.com/bjarneo/cliamp-server). -## Building from source +## 从源码构建 -**Prerequisites:** +**前置条件：** -- [Go](https://go.dev/dl/) 1.25.5 or later -- ALSA development headers (Linux only — required by the audio backend) +- [Go](https://go.dev/dl/) 1.25.5 或更高版本 +- ALSA 开发头文件（仅 Linux — 音频后端需要） -**Linux (Debian/Ubuntu):** +**Linux (Debian/Ubuntu)：** ```sh sudo apt install libasound2-dev ``` -**Linux (Fedora):** +**Linux (Fedora)：** ```sh sudo dnf install alsa-lib-devel libvorbis-devel flac-devel ``` -**Linux (Arch):** +**Linux (Arch)：** ```sh sudo pacman -S alsa-lib ``` -**macOS:** No extra dependencies — CoreAudio is used. +**macOS：** 无需额外依赖 — 使用 CoreAudio。 -**Windows:** No extra SDKs required for the core player. `ffmpeg.exe` and `yt-dlp.exe` remain optional runtime dependencies for the same formats/providers as on other platforms. Spotify is not available on Windows builds. +**Windows：** 核心播放器无需额外 SDK。`ffmpeg.exe` 和 `yt-dlp.exe` 仍是可选运行时依赖，支持的格式/提供商与其他平台相同。Windows 构建不支持 Spotify。 -**Clone and build:** +**克隆并构建：** ```sh git clone https://github.com/bjarneo/cliamp.git @@ -137,52 +136,52 @@ cd cliamp make && make install ``` -Or without Make: `go build -o cliamp .` +或不使用 Make：`go build -o cliamp .` -`make install` places the binary in `~/.local/bin/`. +`make install` 会将二进制文件置于 `~/.local/bin/`。 -**Optional runtime dependencies:** +**可选运行时依赖：** -- [ffmpeg](https://ffmpeg.org/) — for AAC, ALAC, Opus, and WMA playback -- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — for YouTube, SoundCloud, Bandcamp, Bilibili, and NetEase Cloud Music +- [ffmpeg](https://ffmpeg.org/) — 用于播放 AAC、ALAC、Opus 和 WMA +- [yt-dlp](https://github.com/yt-dlp/yt-dlp) — 用于 YouTube、SoundCloud、Bandcamp、Bilibili 和网易云音乐 -## Docs +## 文档 -- [Configuration](docs/configuration.md) -- [Keybindings](docs/keybindings.md) -- [CLI Flags](docs/cli.md) -- [Streaming](docs/streaming.md) -- [Playlists](docs/playlists.md) -- [YouTube, SoundCloud, Bandcamp and Bilibili](docs/yt-dlp.md) +- [配置](docs/configuration.md) +- [按键绑定](docs/keybindings.md) +- [CLI 参数](docs/cli.md) +- [流媒体](docs/streaming.md) +- [播放列表](docs/playlists.md) +- [YouTube、SoundCloud、Bandcamp 与 Bilibili](docs/yt-dlp.md) - [YouTube Music](docs/youtube-music.md) -- [NetEase Cloud Music](docs/netease.md) +- [网易云音乐](docs/netease.md) - [SoundCloud](docs/soundcloud.md) -- [Lyrics](docs/lyrics.md) +- [歌词](docs/lyrics.md) - [Spotify](docs/spotify.md) - [Navidrome](docs/navidrome.md) - [Plex](docs/plex.md) - [Jellyfin](docs/jellyfin.md) -- [Themes](docs/themes.md) -- [SSH Streaming](docs/ssh-streaming.md) -- [Remote Control (IPC)](docs/remote-control.md) -- [Headless Daemon Mode](docs/headless.md) -- [Audio Quality](docs/audio-quality.md) -- [Media Controls](docs/mediactl.md) -- [Quickshell Now-Playing Widget (Omarchy)](docs/quickshell.md) -- [Lua Plugins](docs/plugins.md) - - [Community Plugins](docs/community-plugins.md) - - [Soap Bubbles Visualizer](https://github.com/bjarneo/cliamp-plugin-soap-bubbles) +- [主题](docs/themes.md) +- [SSH 流媒体](docs/ssh-streaming.md) +- [远程控制（IPC）](docs/remote-control.md) +- [无界面守护进程模式](docs/headless.md) +- [音频质量](docs/audio-quality.md) +- [媒体控制](docs/mediactl.md) +- [Quickshell 正在播放组件（Omarchy）](docs/quickshell.md) +- [Lua 插件](docs/plugins.md) + - [社区插件](docs/community-plugins.md) + - [肥皂泡可视化器](https://github.com/bjarneo/cliamp-plugin-soap-bubbles) -## Troubleshooting +## 故障排除 -**No audio output (silence with no errors)** +**无音频输出（无错误但静默）** -On Linux systems using PipeWire or PulseAudio, cliamp's ALSA backend needs a bridge package to route audio through your sound server: +在使用 PipeWire 或 PulseAudio 的 Linux 系统上，cliamp 的 ALSA 后端需要桥接包才能将音频路由至声音服务器： -- **PipeWire:** `pipewire-alsa` -- **PulseAudio:** `pulseaudio-alsa` +- **PipeWire：** `pipewire-alsa` +- **PulseAudio：** `pulseaudio-alsa` -Install the appropriate package for your system: +请为你的系统安装相应软件包： ```sh # PipeWire (Arch) @@ -195,10 +194,10 @@ sudo pacman -S pulseaudio-alsa sudo apt install pipewire-alsa ``` -## Author +## 作者 [x.com/iamdothash](https://x.com/iamdothash) -## Disclaimer +## 免责声明 -Use this software at your own risk. We are not responsible for any damages or issues that may arise from using this software. +使用本软件风险自负。我们对因使用本软件可能产生的任何损害或问题不承担责任。