From 7b6e3867b02e2546dcd179238f2f1694c981a20c Mon Sep 17 00:00:00 2001 From: Victor Adossi <123968127+vados-cosmonic@users.noreply.github.com> Date: Fri, 8 Nov 2024 07:38:50 +0900 Subject: [PATCH] fix(examples): mention wac in string-reverse-upper README (#521) Signed-off-by: Victor Adossi --- examples/components/string-reverse-upper/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/examples/components/string-reverse-upper/README.md b/examples/components/string-reverse-upper/README.md index 810b6fb97..dbf04f24d 100644 --- a/examples/components/string-reverse-upper/README.md +++ b/examples/components/string-reverse-upper/README.md @@ -42,7 +42,7 @@ world revup { ## Dependencies -First, install required dependencies: +First, install required project-level dependencies: ```console npm install @@ -51,6 +51,11 @@ npm install > [!NOTE] > As this is a regular NodeJS project, you can use your package manager of choice (e.g. `yarn`, `pnpm`) +Along with projet related dependencies, since this is a *compound* component (this component is composed with another), +we'll need to install the [WebAssembly Composition tool (`wac`)][wac], which we will use later to compose components. + +[wac]: https://github.com/bytecodealliance/wac + ## Building the WebAssembly binary (pre-composition) Then, build the component with `jco`: @@ -97,6 +102,9 @@ The component we will be composing with our as-of-yet incomplete binary *must* s npm run compose ``` +> [!WARN] +> This step is the one that uses [`wac`][wac] -- ensure it's installed! + Running the command above will produce a `string-reverse-upper.wasm` file (this time, that is *complete*). After running component composition, there will be a component with all its imports satisfied, called `string-reverse-upper.composed.wasm`.