sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-02-27 18:22:41 -08:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Kyle Yasuda
2026-02-14 01:44:52 -08:00
parent 61cf0a2570
commit d2ca24f1c7
4 changed files with 185 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/development.md
View File

@@ -41,12 +41,22 @@ pnpm run dev # builds + launches with --start --dev flags
## Testing
```bash
pnpm run test:config # Config schema and validation tests
pnpm run test:core # Core service tests (~67 tests)
pnpm run test:subtitle # Subtitle pipeline tests
pnpm run test:config # Config schema and validation tests (build + run)
pnpm run test:core # Core service tests (~67 tests) (build + run)
pnpm run test:subtitle # Subtitle pipeline tests (build + run)
```
All test commands build first, then run via Node's built-in test runner (`node --test`).
All legacy test commands build first, then run via Node's built-in test runner (`node --test`).
For faster iteration while editing test code:
```bash
pnpm run build # one-time compile
pnpm run test:config:dist # no rebuild
pnpm run test:core:dist # no rebuild
pnpm run test:subtitle:dist # no rebuild
pnpm run test:fast # run all tests without rebuild (assumes build is already current)
```
## Config Generation
@@ -95,6 +105,7 @@ Run `make help` for a full list of targets. Key ones:
| Variable | Description |
| --- | --- |
| `SUBMINER_APPIMAGE_PATH` | Override AppImage location for subminer script |
| `SUBMINER_BINARY_PATH` | Alias for `SUBMINER_APPIMAGE_PATH` |
| `SUBMINER_YT_SUBGEN_MODE` | Override `youtubeSubgen.mode` for launcher |
| `SUBMINER_WHISPER_BIN` | Override `youtubeSubgen.whisperBin` for launcher |
| `SUBMINER_WHISPER_MODEL` | Override `youtubeSubgen.whisperModel` for launcher |