Skip to content

Commit

Permalink
doc: add very basic README
Browse files Browse the repository at this point in the history
Signed-off-by: Roman Volosatovs <[email protected]>
  • Loading branch information
rvolosatovs committed Sep 23, 2024
1 parent 6817d4e commit a052e21
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a052e21

Please sign in to comment.