From 71ec9e341acf70232de3ce28589a6e4c1694893a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Remko=20Tron=C3=A7on?= Date: Wed, 1 Jun 2022 21:47:32 +0200 Subject: [PATCH] Add README.md --- src/standalone/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 src/standalone/README.md diff --git a/src/standalone/README.md b/src/standalone/README.md new file mode 100644 index 0000000..55e4b5e --- /dev/null +++ b/src/standalone/README.md @@ -0,0 +1,26 @@ +# Standalone native WAForth binary + +This directory contains a small C program to run the WAForth WebAssembly core +in a native WebAssembly engine. + +The build currently uses the [Wasmtime](https://wasmtime.dev) engine, +but its build configuration can easily be adapted to build using any +WebAssembly engine that supports the +[WebAssembly C API](https://github.com/WebAssembly/wasm-c-api) (although some +engines have [known issues](https://github.com/remko/waforth/issues/6#issue-326830993)). + +## Download + +You can download a pre-built binary of the standalone shell from +[the Releases page](https://github.com/remko/waforth/releases). + + +## Building + +Download dependencies (Wasmtime): + + make install-deps + +Build: + + make