some hygiene

This commit is contained in:
2026-08-09 23:39:35 -04:00
parent f758b53336
commit d2f6c5c525
2 changed files with 9 additions and 26 deletions

View File

@@ -19,12 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
---
This project bundles third-party components under their own licenses:
- **cava** (karlstav/cava, vendored under `cava/`) — MIT,
Copyright (c) 2015 Karl Stavestrand. See `cava/LICENSE-cava.txt`.
- **Bun runtime** (embedded in the standalone binary) — MIT.
- **OpenTUI** (`@opentui/core`) — MIT.

View File

@@ -26,18 +26,9 @@ external player with full transport control — all from your terminal.
- A terminal with UTF-8 and modern color support (kitty, iTerm2, WezTerm, - A terminal with UTF-8 and modern color support (kitty, iTerm2, WezTerm,
tmux, GNOME Terminal, etc.). tmux, GNOME Terminal, etc.).
- An **audio player** on `PATH`. PodTui auto-detects in priority order: - **mpv** on `PATH` for audio playback. PodTui drives mpv over JSON IPC, so
seek, speed, and position tracking all work. Without `mpv` on `PATH`,
| Player | Platforms | Seek | Speed | Position tracking | playback is a silent no-op (the `none` backend).
|----------|----------------|:----:|:-----:|:------------------|
| `mpv` | any | ✔ | ✔ | ✔ (recommended) |
| `ffplay` | any | ✔ | ✘ | ✘ |
| `afplay` | macOS built-in | ✔ | ✔ | ✘ |
| `open`/`xdg-open` | any | ✘ | ✘ | ✘ |
Install `mpv` for the best experience (`brew install mpv`,
`sudo apt install mpv`, `pacman -S mpv`). You can force a specific backend
with `PODTUI_AUDIO_BACKEND=mpv|ffplay|afplay|system|none`.
## Installation ## Installation
@@ -47,7 +38,7 @@ Linux (arm64/x64). Pick whichever fits your platform.
### 1. Homebrew (macOS) ### 1. Homebrew (macOS)
```sh ```sh
brew install mikefreno/tap/podtui # requires mpv: brew install mpv brew install mikefreno/tap/podtui
``` ```
> The formula installs the standalone binary plus its two native libraries > The formula installs the standalone binary plus its two native libraries
@@ -98,8 +89,7 @@ symlink, and pulls in `mpv` (the sole audio backend) as a dependency.
> >
> Publishing is on hold until [AUR account registrations](https://aur.archlinux.org) > Publishing is on hold until [AUR account registrations](https://aur.archlinux.org)
> reopen (suspended while the AUR team works on suspicious-package > reopen (suspended while the AUR team works on suspicious-package
> moderation). Once a key can be registered, push `PKGBUILD` + `.SRCINFO` > moderation).
> with `git push ssh://aur@aur.archlinux.org/podtui-bin` and update this note.
### 4. From source ### 4. From source
@@ -177,12 +167,14 @@ default (`$XDG_CONFIG_HOME/podtui` if set).
| File | Purpose | | File | Purpose |
|------|---------| |------|---------|
| `feeds.json` | Your subscribed feeds (RSS/podcast sources) | | `config.json` | Unified settings (theme, playback speed, download path), feeds, and custom feed sources |
| `sources.json` | Custom feed sources |
| `downloads.json` | Downloaded episode metadata | | `downloads.json` | Downloaded episode metadata |
| `keybinds.jsonc` | Keybinding remaps (see above) | | `keybinds.jsonc` | Keybinding remaps (see above) |
| `themes/` | Optional custom theme files | | `themes/` | Optional custom theme files |
Legacy `feeds.json`, `sources.json`, and `app-state.json` are auto-migrated
into `config.json` on first run.
Env overrides: `PODTUI_AUDIO_BACKEND`, `XDG_CONFIG_HOME`. Startup also reads Env overrides: `PODTUI_AUDIO_BACKEND`, `XDG_CONFIG_HOME`. Startup also reads
the same OpenTUI environment variables. the same OpenTUI environment variables.