README: document the contribution flow and the WebAssembly target - #559
Merged
Merged
Conversation
Two things the README did not say: that development happens on next and that an open issue is not proof of an unfixed bug, and that a WASM build wraps nothing - it compiles the CLAP itself into a .wclap.
Collaborator
|
happy to merge this |
baconpaul
approved these changes
Sep 14, 2026
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
2 participants
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.
Two gaps in the README, both of which cost a newcomer (or an agent) a wrong assumption.
Contribution. Nothing said that development happens on
nextand thatmainonly moves at a release. The more expensive omission: issues here are not closed when a fix lands, so an open issue is not evidence of an unfixed bug — #390, #521, #522, #523 and #525 are all fixed onnextand still open. Someone checking GitHub before reporting would conclude the opposite.WebAssembly. The WASM path was undocumented outside the CMake. It is easy to assume it means "a VST3 in the browser", when in fact nothing is wrapped: the build compiles the CLAP itself into a
.wclap, and VST3, AUv2, AUv3, AAX and standalone are all unavailable there.Everything in the WASM paragraph comes from the build files:
cmake/make_clapfirst.cmake:74-91—PLUGIN_FORMATSdefaults toWCLAPalone, other formats forced offcmake/shared_prologue.cmake:56-61— Emscripten /wasm32/wasm64detectioncmake/make_clapfirst.cmake:344-352—-msimd128,clap_entryandmallocexportscmake/wrap_wclap.cmake:25-51— bundle vs. flat output layoutDocumentation only; no code or build changes.
One caveat worth a maintainer's eye, deliberately left out of the README:
shared_prologue.cmake:61setsANY_WASM_TOOLCHAINwithPARENT_SCOPE, while line 64 tests it in the current scope, where that leaves it unset. Reproducing the same scope structure in a throwaway CMake project, CMake warns and theEMSbranch is not taken. If that is a real bug, this README now describes intended rather than actual behaviour — happy to open a separate issue.