Repository navigation
Conversation
TeensyROM Suite 1.0.0-beta.1 replaced TeensyROM Web, the TeensyROM UI desktop app and TeensyROM-CLI with one suite: Trom UI, Trom Terminal, Trom Agent and Trom API. The old repos are archived, so the docs that pointed at them now name the Suite apps and link their docs. The C64 Ultimate page shows what the Suite does today, the DJ Mixer joins the ASID sources, and the protocol notes name Trom API as the client that depends on the command format.
With TeensyROM Suite, Trom API holds the cart's serial port, not a desktop app, and it keeps holding it after the browser is closed. `trom api stop` releases it.
The README's remote control list, transfer line and thank-you credit pointed at TeensyROM Web, the TeensyROM UI desktop app and TeensyROM-CLI, which TeensyROM Suite 1.0.0-beta.1 replaced. They now describe the four Trom apps and link their docs, and a DJ Mixer video joins Demo Videos.
MetalHexx
commented
Nov 4, 2026
MetalHexx
commented
Nov 4, 2026
MetalHexx
commented
Nov 4, 2026
MetalHexx
commented
Nov 4, 2026
The README's remote control entry is back to one line, like the rest of that list. The C64 Ultimate page calls Trom Agent what it is, an AI companion, rather than quoting example requests. The DJ Mixer runs in any browser with MIDI support, not only Chrome or Edge.
Both lines mean any TeensyROM app that holds the serial port, not Trom API alone, so they go back to upstream's wording.
MetalHexx
force-pushed
the
docs/trom-suite-docs
branch
from
November 4, 2026 04:12
151662a to
dd25e72
Compare
TeensyROM Suite adds a 64-bit ARM Linux build for Raspberry Pi, so the places that name the Suite's platforms include it.
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the documentation and comment updates introducing TeensyROM Suite.
No open issues 🎉
What changed in this PR
Updates TeensyROM documentation to present TeensyROM Suite as the successor to the separate Web, UI, and CLI apps. Changes are limited to documentation and comments; firmware, protocols, and tool behavior are unchanged.
Changes:
- Replaces legacy app references with Trom UI, Trom Terminal, Trom Agent, and Trom API.
- Documents Suite features, including the DJ Mixer, file transfers, themes, and ASID setup.
- Updates contributor guidance and debug-script instructions to use current app names.
| File | Description |
|---|---|
| tools/Debug/run_z_sweep.py | Updates the docstring to recommend stopping Trom API before use. |
| tools/Debug/dma_scope_write.py | Updates the docstring’s serial-port release instructions. |
| README.md | Introduces Suite apps, transfer options, and DJ Mixer videos. |
| docs/General_Usage.md | Links Suite tools for transferring firmware files. |
| docs/Ethernet_Usage.md | Describes Trom API’s network support and HTTP interface. |
| docs/ControlComms.md | Replaces legacy clients with Suite and Trom API entries. |
| docs/C64_Ultimate_Enhancements.md | Expands Suite feature descriptions and links. |
| docs/ASID_Player.md | Adds DJ Mixer setup and updates the preset-tool link. |
| docs/Architecture/Comms-Protocol.md | Names Trom API as a protocol client. |
| CONTRIBUTING.md | Updates companion-app and downstream dependency references. |
| CLAUDE.md | Updates the remote-protocol dependency description. |
| .claude/agents/steward.md | Updates the protocol-contract guidance to name Trom API. |
Review effort: Balanced
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
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.
TeensyROM Suite 1.0.0-beta.1 replaced TeensyROM Web, the TeensyROM UI desktop app and TeensyROM-CLI with one suite: Trom UI (the web app, with the DJ Mixer), Trom Terminal, Trom Agent and Trom API. The TeensyROM-UI and TeensyROM-CLI repos are archived. This updates the docs that pointed at the old apps so they describe the suite as it is today and link its docs.
trom api stopreleases it).Docs and comments only; no firmware, protocol or tool behavior change. Not hardware tested (nothing to test on hardware).