From 92ccc97d57dae76ecd7cb9e7295c7a3cfa21be82 Mon Sep 17 00:00:00 2001 From: Roman Volosatovs Date: Mon, 23 Sep 2024 19:32:04 +0200 Subject: [PATCH] doc: add very basic README Signed-off-by: Roman Volosatovs --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e26797e --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Description + +`west` is a testing framework, which lets you test your WebAssembly applications natively and using all your existing development tools (e.g. debuggers). + +## Go + +`west` provides `west-bindgen-go` utility, which walks the complete AST of your application and generates a binding file, which replaces functions with `wasmimport` directives, normally provided by the runtime, by a native implementation, which invokes those imports on a WebAssembly component (harness) running in an embedded Wasmtime instance. This lets you test you applications without changing implementation and achieving full test coverage. + +# Design + +`west` uses [`cabish`](https://github.com/rvolosatovs/cabish) to read and write values over FFI to pass to embedded Wasmtime instance.