Add a README.md for the spidermonkey-wasm subdirectory

alexcrichton · Sep 21, 2021 · 831bd7d · 831bd7d
1 parent 28980ad
commit 831bd7d
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/crates/gen-spidermonkey/spidermonkey-wasm/README.md b/crates/gen-spidermonkey/spidermonkey-wasm/README.md
@@ -0,0 +1,13 @@
+# `spidermonkey.wasm`
+
+This directory contains the source code for `spidermonkey.wasm`, which is an
+embedding of the SpiderMonkey JavaScript engine for targeting `wasm32-wasi` and
+use with `witx-bindgen-gen-spidermonkey`. It exports a variety of helper
+functions that are used by `witx-bindgen-gen-spidermonkey`'s generated glue
+code. These helpers are typically named something like `SMW_whatever_function`.
+
+## Building `spidermonkey.wasm`
+
+```
+make
+```