Go to file
Syrus Akbary ee67bf95db
Merge pull request #106 from wasmerio/feature/improved-docs
Improved docs, adding repo structure and libraries README
2019-01-22 16:08:18 -05:00
.circleci Updated brew cache keys 2019-01-18 14:28:07 -08:00
examples Make nginx work on Linux 2019-01-17 18:53:19 +01:00
integration_tests/nginx Cleanup CI testing 2019-01-18 12:20:13 -08:00
lib Improved docs 2019-01-22 12:23:53 -08:00
src Library restructure (#104) 2019-01-22 11:02:06 -08:00
.appveyor.yml add an appveyor file (#94) 2019-01-16 14:27:09 -08:00
.gitignore Ignore intellij settings 2019-01-17 23:19:14 +01:00
ARCHITECTURE.md Added first draft of Wasmer ARCHITECTURE 2018-11-28 16:43:11 -08:00
ATTRIBUTIONS.md Add Emscripten tests/core tests 2018-12-27 01:46:41 -06:00
binary-name.sh Trying to autoplublish releases 2018-11-13 10:38:09 -08:00
Cargo.lock Library restructure (#104) 2019-01-22 11:02:06 -08:00
Cargo.toml Library restructure (#104) 2019-01-22 11:02:06 -08:00
install.sh Refactor and remove bash-specific syntax 2018-12-12 01:10:58 +01:00
LICENSE Improved README and added MIT LICENSE 2018-10-14 23:54:28 +02:00
logo.png Updated logo 2018-11-12 18:50:58 -08:00
Makefile Library restructure (#104) 2019-01-22 11:02:06 -08:00
README.md Improved docs 2019-01-22 12:23:53 -08:00
rustfmt.toml Added support for 0 or 2 params in main emscripten function 2018-12-15 22:51:10 -08:00

Wasmer logo

Build Status License

Introduction

Wasmer is a Standalone JIT WebAssembly runtime, aiming to be fully compatible with Emscripten, Rust and Go.

Install Wasmer with:

curl https://get.wasmer.io -sSfL | sh

Usage

wasmer can execute both the standard binary format (.wasm) and the text format defined by the WebAssembly reference interpreter (.wat).

Once installed, you will be able to run any WebAssembly files (including Nginx, and Lua!):

# Run Lua
wasmer run examples/lua.wasm

# Run Nginx
wasmer run examples/nginx/nginx.wasm -- -p examples/nginx -c nginx.conf

Code Structure

Wasmer is structured into different directories:

  • src: code related to the wasmer excutable binary itself
  • lib: modularized libraries that Wasmer uses under the hood

Building & Running

To build this project you will need Rust and Cargo.

# checkout code
git clone https://github.com/wasmerio/wasmer.git
cd wasmer

# install tools
# make sure that `python` is accessible.
cargo install --path .

Testing

Thanks to spectests we can assure 100% compatibility with the WebAssembly spec test suite.

Tests can be run with:

make test

If you need to re-generate the Rust tests from the spectests you can run:

make spectests

You can also run integration tests with:

make integration-tests

Roadmap

Wasmer is an open project guided by strong principles, aiming to be modular, flexible and fast. It is open to the community to help set its direction.

Below are some of the goals (written with order) of this project:

  • It should be 100% compatible with the WebAssembly Spectest
  • It should be fast (partially achieved)
  • Support Emscripten calls (on the works)
  • Support Rust ABI calls
  • Support GO ABI calls

Architecture

If you would like to know how Wasmer works under the hood, please visit our ARCHITECTURE document.

License

MIT/Apache-2.0

Attributions.