README: lead with requirements and Docker, refresh for the editor

Conversation 1 Commits 2 Files Changed 5

+225 -248

2 Commits

Author	SHA1	Message	Date
branderson	0147386f8e	README: lead with requirements and Docker, refresh for the editor tests / test (pull_request_target) Successful in 4m50s Details The README described a CLI with a minimal web UI and told people to fix charts in Yass. Rewrite it around how songtrace is used now: what it does, its requirements up front (an NVIDIA GPU, tested on 12 GB, Docker with the NVIDIA Container Toolkit, a Whisper server of your own, disk for models and per-song files), a Docker quick start including writing songs straight into a game's collection, then reviewing, editing and rebuilding in the web UI. The command line moves near the end. Regenerate the screenshot to show the note sheet: the screenshot script now seeds the featured song with syllables, a chart, a pitch track and a line break, and always scrolls to the review. The example config no longer sets a real person as #CREATOR, and uses a reserved example host for Whisper.	2026-10-15 17:06:19 -07:00
branderson	95ca68cc59	webui: keep a far line break from stretching the sheet Since breaks could be moved, the sheet widened its window to show the breaks either side of a line. Before an instrumental passage the break sits mid-gap, sometimes 15s away, so the line's notes were crushed into a corner of the sheet. The window now grows at most 3s past the line to show a break; one further off is pinned to the edge, labelled with an arrow toward where it lies, and still drags inward.	2026-10-15 17:06:19 -07:00

Author

SHA1

Message

Date

branderson

0147386f8e

README: lead with requirements and Docker, refresh for the editor

tests / test (pull_request_target) Successful in 4m50s

Details

The README described a CLI with a minimal web UI and told people to fix
charts in Yass. Rewrite it around how songtrace is used now: what it
does, its requirements up front (an NVIDIA GPU, tested on 12 GB, Docker
with the NVIDIA Container Toolkit, a Whisper server of your own, disk for
models and per-song files), a Docker quick start including writing songs
straight into a game's collection, then reviewing, editing and
rebuilding in the web UI. The command line moves near the end.

Regenerate the screenshot to show the note sheet: the screenshot script
now seeds the featured song with syllables, a chart, a pitch track and a
line break, and always scrolls to the review. The example config no
longer sets a real person as #CREATOR, and uses a reserved example host
for Whisper.

2026-10-15 17:06:19 -07:00

branderson

95ca68cc59

webui: keep a far line break from stretching the sheet

Since breaks could be moved, the sheet widened its window to show the
breaks either side of a line. Before an instrumental passage the break
sits mid-gap, sometimes 15s away, so the line's notes were crushed into
a corner of the sheet. The window now grows at most 3s past the line to
show a break; one further off is pinned to the edge, labelled with an
arrow toward where it lies, and still drags inward.

2026-10-15 17:06:19 -07:00

README: lead with requirements and Docker, refresh for the editor #36