diff --git a/README.md b/README.md index f59a7715..6cfe9c8e 100644 --- a/README.md +++ b/README.md @@ -241,7 +241,11 @@ See the [build-from-source guide](https://docs.subminer.moe/installation#from-so -### 2. Check Dependencies +### 2. First Launch + +Run the app. On first launch SubMiner starts in the system tray, creates a default config, and opens a setup popup to finish config, install the mpv plugin, and configure Yomitan dictionaries. + +### 3. Verify Setup ```bash subminer doctor # verify mpv, ffmpeg, config, and socket @@ -250,10 +254,6 @@ subminer doctor # verify mpv, ffmpeg, config, and socket > [!NOTE] > On Windows, use `bun run subminer doctor` or run `SubMiner.exe` directly — first-run setup will guide you through dependency checks. -### 3. First Launch - -Run the app. On first launch SubMiner starts in the system tray, creates a default config, and opens a setup popup to finish config, install the mpv plugin, and configure Yomitan dictionaries. - ### 4. Mine ```bash diff --git a/docs-site/installation.md b/docs-site/installation.md index c95d59dc..6affaec6 100644 --- a/docs-site/installation.md +++ b/docs-site/installation.md @@ -388,21 +388,12 @@ AnkiConnect listens on `http://127.0.0.1:8765` by default. SubMiner will connect For enrichment configuration (sentence, audio, screenshot fields), see [Anki Integration](/anki-integration). -## Verify Installation +## First-Run Setup -After installing, run the built-in diagnostic to confirm dependencies are in place: +On first launch SubMiner creates a default config file automatically and opens a setup popup. You do **not** need to create the config manually — SubMiner handles it. ```bash -subminer doctor -``` - -This checks for the app binary, mpv, ffmpeg, config file, and socket path. Fix any failures before continuing. - -> [!NOTE] -> On Windows, use `bun run subminer doctor` or run `SubMiner.exe` directly. Replace `SubMiner.AppImage` with `SubMiner.exe` in the direct app commands below. - -```bash -# Play a file (default plugin config auto-starts visible overlay and waits for annotation readiness; first launch may open first-run setup popup) +# Play a file (default plugin config auto-starts visible overlay and waits for annotation readiness; first launch opens first-run setup popup) subminer video.mkv # Optional explicit overlay start for setups with plugin auto_start=no @@ -419,12 +410,6 @@ SubMiner.AppImage --start --dev SubMiner.AppImage --help # Show all CLI options ``` -You should see the overlay appear over mpv. If subtitles are loaded in the video, they will appear as interactive text in the overlay. - -## First-Run Setup - -On first launch SubMiner creates a default config file automatically and opens a setup popup. You do **not** need to create the config manually — SubMiner handles it. - The setup popup walks you through: - **Config file**: auto-created at `~/.config/SubMiner/config.jsonc` (Linux/macOS) or `%APPDATA%\SubMiner\config.jsonc` (Windows) @@ -437,6 +422,21 @@ The `Finish setup` button stays disabled until the plugin is installed and at le > [!TIP] > You can re-open the setup popup at any time with `subminer --setup` or `SubMiner.AppImage --setup`. +You should see the overlay appear over mpv. If subtitles are loaded in the video, they will appear as interactive text in the overlay. + +## Verify Setup + +After completing first-run setup, run the built-in diagnostic to confirm everything is in place: + +```bash +subminer doctor +``` + +This checks for the app binary, mpv, ffmpeg, config file, and socket path. Fix any failures before continuing. + +> [!NOTE] +> On Windows, use `bun run subminer doctor` or run `SubMiner.exe` directly. Replace `SubMiner.AppImage` with `SubMiner.exe` in the direct app commands below. + ## Optional Extras ### Rofi Theme (Linux Only)