Reframe README around the full scene catalog#76
Merged
Conversation
The intro and feature list still described the project as live webcam AV streaming, hiding the video/SID-scope/MIDI/ASID/generative/launcher/ensemble scenes it has grown to cover. Rewrite the opening paragraph to lead with the 'programmable display + audio device running a playlist of scenes' framing, regroup Features by scene/display+audio/overlays/ensemble/control/quick-play, and add a 'What do you want to do?' router table that sends each use case straight to a runnable example config plus its docs/usage.md section.
The credit attributed an 'effective-bit companding analysis' to Jürgen Wothke that isn't actually published on his pages — his webSID/Tiny'R'Sid writeup documents the $D418 filter-bit 'almost 8-bit' playback approach but not the quantitative bit-depth analysis. Point the credit at that real page and reword it to match what's there (the effective-bit reasoning is covered by the already-cited Mahoney and Savona sources). Also fixes the 'techique' typo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README's opening paragraph and Features list still described c64cast as live webcam AV streaming — the shape of the project a while ago. That framing hid most of what it now does: video-file playback, SID-music oscilloscope, MIDI→SID synth, ASID client, slideshows, generative/reactive visuals, native
.prg/.crtlaunching, multi-system ensemble video walls, quick playback, and the vision/menu control surfaces. A skimmer concluded "webcam toy," and there was no fast path from "here's my use case" to a runnable example.What changed (README only)
docs/usage.mdsection, so users land on their case in one click. Every linked path verified to exist.