diff --git a/AGENTS.md b/AGENTS.md index bc63792..ea93edb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -21,6 +21,15 @@ - Release prep: `bun run changelog:build`, review `CHANGELOG.md` + `release/release-notes.md`, commit generated changelog + fragment deletions, then tag. - Release CI expects committed changelog entry already present; do not rely on tag job to invent notes. +## Docs + +- The documentation for this project lives in a separate sister directory: [`../subminer-docs/`](https://github.com/ksyasuda/subminer-docs) +- Read the [`../subminer-docs/development.md`](https://github.com/ksyasuda/subminer-docs/blob/main/development.md) and [`../subminer-docs/architecture.md`](https://github.com/ksyasuda/subminer-docs/blob/main/architecture.md) before making changes and follow the guidelines unless there is a specific reason to deviate +- Make sure the changelog [`../subminer-docs/changelog.md`](https://github.com/ksyasuda/subminer-docs/blob/main/changelog.md) is updated on each release +- Ensure the docs are kept up to date if any new or breaking changes are introduced +- If the sister repo does not exist at `../subminer-docs`, then do not attempt + to update the docs and reference the files from GitHub if needed + ## Flow & Runtime - Use repo’s package manager/runtime; no swaps w/o approval. @@ -31,7 +40,6 @@ - Before handoff: run full gate (lint/typecheck/tests/docs). - CI red: `gh run list/view`, rerun, fix, push, repeat til green. - Keep it observable (logs, panes, tails, MCP/browser tools). -- Release: read `docs/RELEASING.md` ## Git diff --git a/README.md b/README.md index 014b688..da40aac 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,12 @@ SubMiner is an Electron overlay that sits on top of mpv. It turns your video player into a full sentence-mining workstation: -- **Hover to look up** — Yomitan dictionary popups directly on subtitles -- **Keyboard-driven lookup mode** — Navigate token-by-token, keep lookup open across tokens, and control popup scrolling/audio/mining without leaving the overlay -- **One-key mining** — Creates Anki cards with sentence, audio, screenshot, and translation -- **Instant auto-enrichment** — Optional local AnkiConnect proxy enriches new Yomitan cards immediately -- **Reading annotations** — Combines N+1 targeting, frequency-dictionary highlighting, and JLPT underlining while you read -- **Hover-aware playback** — By default, hovering subtitle text pauses mpv and resumes on mouse leave +- **Look up words as you watch** — Yomitan dictionary popups on hover or keyboard-driven token-by-token navigation +- **One-key Anki mining** — Creates cards with sentence, audio, screenshot, and translation; optional local AnkiConnect proxy auto-enriches Yomitan cards instantly +- **Reading annotations** — N+1 targeting, frequency-dictionary highlighting, JLPT underlining, and character name dictionary for anime/manga proper nouns - **Subtitle tools** — Download from Jimaku, sync with alass/ffsubsync -- **Immersion tracking** — SQLite-powered stats on your watch time and mining activity -- **Custom texthooker page** — Built-in custom texthooker page and websocket, no extra setup -- **Annotated websocket API** — Dedicated annotation feed can serve bundled texthooker or external clients with rendered `sentence` HTML plus structured `tokens` -- **Jellyfin integration** — Remote playback setup, cast device mode, and direct playback launch -- **AniList progress** — Track episode completion and push watching progress automatically +- **Jellyfin & AniList integration** — Remote playback, cast device mode, and automatic episode progress tracking +- **Texthooker & API** — Built-in texthooker page and annotated websocket feed for external clients ## Quick start diff --git a/assets/minecard-poster.jpg b/assets/minecard-poster.jpg index c338624..b33b368 100644 Binary files a/assets/minecard-poster.jpg and b/assets/minecard-poster.jpg differ diff --git a/assets/minecard.mkv b/assets/minecard.mkv index 027697f..65cf05d 100644 Binary files a/assets/minecard.mkv and b/assets/minecard.mkv differ diff --git a/assets/minecard.mp4 b/assets/minecard.mp4 index 2885b02..3f9a759 100644 Binary files a/assets/minecard.mp4 and b/assets/minecard.mp4 differ diff --git a/assets/minecard.webm b/assets/minecard.webm index da30d0f..b98e3be 100644 Binary files a/assets/minecard.webm and b/assets/minecard.webm differ