Skip to content

fix: align README and help text with actual implementation (issue #75)#81

Merged
ShadyUnderLight merged 1 commit intomainfrom
fix/issue75-readme-consistency
Apr 27, 2026
Merged

fix: align README and help text with actual implementation (issue #75)#81
ShadyUnderLight merged 1 commit intomainfrom
fix/issue75-readme-consistency

Conversation

@ShadyUnderLight
Copy link
Copy Markdown
Owner

Summary

Fix documentation inconsistencies described in Issue #75.

Changes

1. Cover art fetch order (README.md)

  • Line 15 and lines 188-194 now correctly reflect actual code order:
    1. Embedded cover (priority, no network)
    2. MusicBrainz / Cover Art Archive
    3. iTunes Search API
    4. Local directory image
    5. LeftFM (disabled by default)

2. Project structure section (README.md)

  • Removed non-existent EmbeddedChapterReader.swift and TextChapterParser.swift
  • Updated ChapterSource.swift description to note it handles all chapter parsing
  • Updated AlbumArtFetcher.swift description to match actual order

3. CLI help text (CLI/main.swift)

  • Changed {index:02d} to {index} — the formatter syntax is not actually supported by AudioSplitter.applyNameTemplate()

Verification

  • Swift build succeeds
  • 108 tests pass

@ShadyUnderLight ShadyUnderLight force-pushed the fix/issue75-readme-consistency branch from af8c3ad to 371015f Compare April 27, 2026 10:15
@ShadyUnderLight ShadyUnderLight force-pushed the fix/issue75-readme-consistency branch from 371015f to 9e12a48 Compare April 27, 2026 10:30
@ShadyUnderLight ShadyUnderLight merged commit 82699d4 into main Apr 27, 2026
1 check passed
@ShadyUnderLight ShadyUnderLight deleted the fix/issue75-readme-consistency branch April 27, 2026 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants