xeos
/
wasmi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
wasmi/README.md

54 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

Update README.md
2018-04-17 06:41:26 +00:00
[![crates.io link](https://img.shields.io/crates/v/wasmi.svg)](https://crates.io/crates/wasmi)
[![Build Status](https://travis-ci.org/paritytech/wasmi.svg?branch=master)](https://travis-ci.org/paritytech/wasmi)
# `wasmi`
[skip-ci] Create README.md
2018-01-22 15:47:16 +00:00
Update readme (#167) * Restructure README * Remove point of README Since it dated since it was introduced. Priorities have changed since then, but on the other hand, at the moment of writing we already have a PR. * Remove the note about parity-wasm This now only has historic significance : ) * WASM → Wasm * Expand our vision in more detail.
2019-02-26 14:45:55 +00:00
`wasmi` - a Wasm interpreter.
Add #License header
2018-01-23 16:43:56 +00:00
fix typo
2019-06-07 06:56:19 +00:00
`wasmi` was conceived as a component of [parity-ethereum](https://github.com/paritytech/parity-ethereum) (ethereum-like contracts in wasm) and [substrate](https://github.com/paritytech/substrate). These projects are related to blockchain and require a high degree of correctness, even if that might be over conservative. This specifically means that we are not trying to be involved in any implementation of any of work-in-progress Wasm proposals. We are also trying to be as close as possible to the spec, which means we are trying to avoid features that is not directly supported by the spec. This means that it is flexible on the one hand and on the other hand there shouldn't be a problem migrating to another spec compliant execution engine.
Update README.md
2018-01-23 17:07:09 +00:00
Update readme (#167) * Restructure README * Remove point of README Since it dated since it was introduced. Priorities have changed since then, but on the other hand, at the moment of writing we already have a PR. * Remove the note about parity-wasm This now only has historic significance : ) * WASM → Wasm * Expand our vision in more detail.
2019-02-26 14:45:55 +00:00
With all that said, `wasmi` should be a good option for initial prototyping.
Add ##contribution section.
2018-01-23 16:47:18 +00:00
Add a section in README to show how to build and test (#117)
2018-08-01 09:21:50 +00:00
# Build & Test
As `wasmi` contains a git submodule, you need to use `--recursive` for cloning or to checkout the submodule explicitly, otherwise the testing would fail.
```
git clone https://github.com/paritytech/wasmi.git --recursive
cd wasmi
cargo build
cargo test
```
Add no_std support (#122) * add default-enabled std feature * use parity-wasm/std feature only if std is enabled * drop dependency on std::io * use hashmap_core instead of std::collections::HashMap * disable std::error in no_std * core and alloc all the things * mention no_std in readme * add no_std feature and use hashmap_core only on no_std * rename the no_std feature to core * drop dependency on byteorder/std * simplify float impl macro * remove some trailing whitespace * use libm for float math in no_std * add note about no_std panics of libm to readme * Embed nan-preserving-float crate. * Add no_std check to the Travis CI config * add missing dev-dependency
2018-10-29 10:16:55 +00:00
# `no_std` support
Update readme (#167) * Restructure README * Remove point of README Since it dated since it was introduced. Priorities have changed since then, but on the other hand, at the moment of writing we already have a PR. * Remove the note about parity-wasm This now only has historic significance : ) * WASM → Wasm * Expand our vision in more detail.
2019-02-26 14:45:55 +00:00
Add no_std support (#122) * add default-enabled std feature * use parity-wasm/std feature only if std is enabled * drop dependency on std::io * use hashmap_core instead of std::collections::HashMap * disable std::error in no_std * core and alloc all the things * mention no_std in readme * add no_std feature and use hashmap_core only on no_std * rename the no_std feature to core * drop dependency on byteorder/std * simplify float impl macro * remove some trailing whitespace * use libm for float math in no_std * add note about no_std panics of libm to readme * Embed nan-preserving-float crate. * Add no_std check to the Travis CI config * add missing dev-dependency
2018-10-29 10:16:55 +00:00
This crate supports `no_std` environments.
Enable the `core` feature and disable default features:
```toml
[dependencies]
parity-wasm = {
version = "0.31",
default-features = false,
features = "core"
}
```
The `core` feature requires the `core` and `alloc` libraries and a nightly compiler.
Also, code related to `std::error` is disabled.
Floating point operations in `no_std` use [`libm`](https://crates.io/crates/libm), which sometimes panics in debug mode (https://github.com/japaric/libm/issues/4).
So make sure to either use release builds or avoid WASM with floating point operations, for example by using [`deny_floating_point`](https://docs.rs/wasmi/0.4.0/wasmi/struct.Module.html#method.deny_floating_point).
Update readme (#167) * Restructure README * Remove point of README Since it dated since it was introduced. Priorities have changed since then, but on the other hand, at the moment of writing we already have a PR. * Remove the note about parity-wasm This now only has historic significance : ) * WASM → Wasm * Expand our vision in more detail.
2019-02-26 14:45:55 +00:00
# License
`wasmi` is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0), at your choice.
See LICENSE-APACHE, and LICENSE-MIT for details.
Add ##contribution section.
2018-01-23 16:47:18 +00:00
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `wasmi` by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.