What is here, and what is not. The rule for the split: a guide somebody follows start to finish lives at the repository root (BUILD_GUIDE.md, BUILD_GUIDE_v2.md, PATTERN_GUIDE.md, FEATURE_GUIDE.md, AUDIO_GUIDE.md); a contract, a reference, a walk-through for one task, or a record lives here; and a folder explains itself in its own README. The folder-by-folder map of the whole repository is REPOSITORY.md.
rest-api.md— the device's HTTP API (/api/*), the console pages, and the table for choosing between HTTP, OSC, MIDI and MQTTosc-spec.md— OSC over UDP (DAWs, Max, TouchDesigner)midi-spec.md— the panel as a network MIDI portmqtt-spec.md— MQTT topics, both directions, the roles, and why the channel decides whether a write sticksaudio-ws-spec.md— the audio-react WebSocket the browser extension and the phone app speakpfst-v2-spec.md— the.pfsshow table, with test vectors inpfst-v2-vectors/panel-compatibility.md— a buying guide first (which HUB75 panels light up and which stay dark), then the reference for other sizes
EDITIONS.md— features, compositions, editions: the seam, the rule that the core names no feature, the vocabulary. Read before touching firmware.rfc-core-and-variants.mdand its progress log — the 2026-08 RFC that produced the seam. Historical: it says addon and variant where the tree says feature and edition, and its listing rules have been superseded byEDITIONS.md.
midi-ableton.md— the panel as a MIDI port in Ableton Live, with screenshotsdirector-midi.md— how a Director show becomes a MIDI clip../firmware/CUSTOM_PATTERNS.md— the hands-on pattern route (the everyday one isPATTERN_GUIDE.md)../firmware/patternflow/console/README.md— editing or adding a device console page
assembly/— the assembly map: which enclosure with which electronics, and where each route is documented. The full guide is../BUILD_GUIDE.md; the files to order are described in../hardware/README.md; enclosures other people built are../hardware/case/remixes/- The same build in 3D, step by step, is patternflow.work/guide/build. Its firmware chapter hands over to the Play guide's Flash chapter, which is also where to look when the first flash or the Wi-Fi step goes wrong (the written version is
BUILD_GUIDE.md§8) build-guide/images/— photos for the build guides (images/is the v2 set,images/v3/the current board)LICENSE-SUMMARY.md— MIT for code, CC BY-SA 4.0 for hardware, docs and bundled patterns, and what that means for a pattern you publish or a remix you share
The interactive guide at patternflow.work/guide has four parts, each in English and Korean: Build (soldering one from bare parts), Play (the first hour with a built one: flash, knobs, patterns, console), Make (community and Pattern Lab) and Audio (the Audio edition: a browser tab, the microphone, MIDI with a DAW). They cover the same ground as the guides in the root, and every step has a Stuck here? link that opens an issue with that step filled in.
../CONTRIBUTING.md— one table: what you have → where it goes → what CI runs on it../SUPPORT.md— where to ask whatREPOSITORY.md— the folder-by-folder map, and the list of files that outside things link to
RELEASING.md— thedev→mainroutine, cutting a release, what the workflows attachSERVICES.md— the production hosts (community, build worker) and their systemd units. Korean.
investigations/— dated post-mortemsreleases/— long-form notes for three July 2026 releases, kept as written; notes since 3.2 are on GitHub Releases, andCHANGELOG.mdat the root is the complete recordmanifesto.md— why Patternflow exists, and (section 6) how we treat each otherimages/,media/— assets the guides and the site reference