Open
Description
We need to create project docs. They should probably be in this repo but cover both cockle
and this, and cockle
can link to them too. Need to cover:
- Relationship between the 3 relevant projects:
terminal
,cockle
, emscripten-forgerecipes
. - Configuration required to use
terminal
extension in a JupyterLite deployment. - List of the WASM emscripten-forge command packages available for use, and which are available by default and which are optional.
- How to configure
cockle
at deployment time to include extra WASM command packages, newalias
es and so on. - Explain the relationship between an emscripten-forge "package", WASM "module" (
.wasm
file etc), and individual "command". - Link to a deployment to try it out.
- Limitations such as SharedArrayBuffer, and how they might be removed in the future.
- Contributor docs including encouragement to submit issues in
terminal
orcockle
and we will move and/or duplicate the issues so that they are in the correct place. We'd rather have an issue reported somewhere, even if it is not the correct repo, rather than not reported at all.
Later on, we should also look at a full tutorial showing how to create a new WASM command package from scratch, build and debug it, and how to include it in a deployment. This is probably a separate longer-term issue.