summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlon Zakai <alonzakai@gmail.com>2015-11-12 10:18:02 -0800
committerAlon Zakai <alonzakai@gmail.com>2015-11-12 10:18:02 -0800
commitd226b1f67d2f42867e83e59fb362cf032b893c21 (patch)
treecf1fdc98141e2622aa86c7b133bc143066416854
parent53c3592f51861d8568be66f18bafbedda44d1484 (diff)
downloadbinaryen-d226b1f67d2f42867e83e59fb362cf032b893c21.tar.gz
binaryen-d226b1f67d2f42867e83e59fb362cf032b893c21.tar.bz2
binaryen-d226b1f67d2f42867e83e59fb362cf032b893c21.zip
readme update
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index ff87079b9..0eb845a0a 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
Binaryen is a C++ library for WebAssembly. It can:
* **Interpret** WebAssembly. It passes 100% of the spec test suite.
- * **Compile** asm.js to WebAssembly, which together with [Emscripten](http://emscripten.org), gives you a complete compiler toolchain from C and C++ to WebAssembly.
+ * **Compile** asm.js to WebAssembly, which together with [Emscripten](http://emscripten.org), gives you a complete compiler toolchain from C and C++ to WebAssembly (Emscripten compiles C and C++ to asm.js, Binaryen compile that to WebAssembly).
* **Polyfill** WebAssembly, by running it in the interpreter compiled to JavaScript, if the browser does not yet have native support.
To provide those capabilities, Binaryen has a simple and flexible API for **representing and processing** WebAssembly modules. The interpreter, validator, pretty-printer, etc. are built on that foundation. The core of this is in [wasm.h](https://github.com/WebAssembly/binaryen/blob/master/src/wasm.h), which contains classes that define a WebAssembly module, and tools to process those. For a simple example of how to use Binaryen, see [test/example/find_div0s.cpp](https://github.com/WebAssembly/binaryen/blob/master/test/example/find_div0s.cpp), which creates a module and then searches it for a specific pattern.
@@ -131,11 +131,11 @@ Same as Emscripten: MIT license.
## FAQ
-##### How does `asm2wasm` relate to the new WebAssembly backend which is being developed in upstream LLVM?
+* How does `asm2wasm` relate to the new WebAssembly backend which is being developed in upstream LLVM?
This is separate from that. `asm2wasm` focuses on compiling asm.js to WebAssembly, as emitted by Emscripten's asm.js backend. This is useful because while in the long term Emscripten hopes to use the new WebAssembly backend, the `asm2wasm` route is a very quick and easy way to generate WebAssembly output. It will also be useful for benchmarking the new backend as it progresses.
-##### Why the weird name for the project?
+* Why the weird name for the project?
"Binaryen" is a combination of **binary** - since WebAssembly is a binary format for the web - and **Emscripten** - with which it can integrate in order to compile C and C++ all the way to WebAssembly, via asm.js. Binaryen began as Emscripten's WebAssembly processing library (`wasm-emscripten`).