diff options
Diffstat (limited to 'vendor/github.com/go-interpreter/wagon/README.md')
| -rw-r--r-- | vendor/github.com/go-interpreter/wagon/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/vendor/github.com/go-interpreter/wagon/README.md b/vendor/github.com/go-interpreter/wagon/README.md new file mode 100644 index 000000000..3d2558e3d --- /dev/null +++ b/vendor/github.com/go-interpreter/wagon/README.md @@ -0,0 +1,28 @@ +wagon +===== + +[](https://travis-ci.org/go-interpreter/wagon) +[](https://codecov.io/gh/go-interpreter/wagon) +[](https://godoc.org/github.com/go-interpreter/wagon) + +`wagon` is a [WebAssembly](http://webassembly.org)-based interpreter in [Go](https://golang.org), for [Go](https://golang.org). + +**NOTE:** `wagon` requires `Go >= 1.9.x`. + +## Purpose + +`wagon` aims to provide tools (executables+libraries) to: + +- decode `wasm` binary files +- load and execute `wasm` modules' bytecode. + +`wagon` doesn't concern itself with the production of the `wasm` binary files; +these files should be produced with another tool (such as [wabt](https://github.com/WebAssembly/wabt) or [binaryen](https://github.com/WebAssembly/binaryen).) +`wagon` *may* provide a utility to produce `wasm` files from `wast` or `wat` files (and vice versa.) + +The primary goal of `wagon` is to provide the building blocks to be able to build an interpreter for Go code, that could be embedded in Jupyter or any Go program. + + +## Contributing + +See the [CONTRIBUTING](https://github.com/go-interpreter/license/blob/master/CONTRIBUTE.md) guide for pointers on how to contribute to `go-interpreter` and `wagon`. |