From 5a92e6b450f597cbe29ff089a259dd94ed9bb6d4 Mon Sep 17 00:00:00 2001 From: Jordan Danford Date: Mon, 30 Sep 2019 19:47:10 -0700 Subject: [PATCH 1/2] Make minor fixes to README.md --- CHANGELOG.md | 5 +++-- README.md | 28 ++++++++++++++++------------ 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5244fa6244a..4612f570425 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ Blocks of changes will separated by version increments. ## **[Unreleased]** +- [#852](https://github.com/wasmerio/wasmer/pull/852) Make minor grammar/capitalization fixes to README.md - [#841](https://github.com/wasmerio/wasmer/pull/841) Slightly improve rustdoc documentation and small updates to outdated info in readme files - [#835](https://github.com/wasmerio/wasmer/pull/836) Update Cranelift fork version to `0.44.0` - [#836](https://github.com/wasmerio/wasmer/pull/836) Update Cranelift fork version to `0.44.0` @@ -50,7 +51,7 @@ Special thanks to @YaronWittenstein @penberg for their contributions. - [#702](https://github.com/wasmerio/wasmer/issues/702) Add SharedMemory to Wasmer. Add `--enable-threads` flag, add partial implementation of atomics to LLVM backend. - [#698](https://github.com/wasmerio/wasmer/issues/698) [#690](https://github.com/wasmerio/wasmer/issues/690) [#687](https://github.com/wasmerio/wasmer/issues/690) Fix panics in Emscripten - [#689](https://github.com/wasmerio/wasmer/issues/689) Replace `wasmer_runtime_code::memory::Atomic` with `std::sync::atomic` atomics, changing its interface -- [#680](https://github.com/wasmerio/wasmer/issues/680) [#673](https://github.com/wasmerio/wasmer/issues/673) [#669](https://github.com/wasmerio/wasmer/issues/669) [#660](https://github.com/wasmerio/wasmer/issues/660) [#659](https://github.com/wasmerio/wasmer/issues/659) Misc. runtime and singlepass fixes +- [#680](https://github.com/wasmerio/wasmer/issues/680) [#673](https://github.com/wasmerio/wasmer/issues/673) [#669](https://github.com/wasmerio/wasmer/issues/669) [#660](https://github.com/wasmerio/wasmer/issues/660) [#659](https://github.com/wasmerio/wasmer/issues/659) Misc. runtime and singlepass fixes - [#677](https://github.com/wasmerio/wasmer/issues/677) [#675](https://github.com/wasmerio/wasmer/issues/675) [#674](https://github.com/wasmerio/wasmer/issues/674) LLVM backend fixes and improvements - [#671](https://github.com/wasmerio/wasmer/issues/671) Implement fs polling in `wasi::poll_oneoff` for Unix-like platforms - [#656](https://github.com/wasmerio/wasmer/issues/656) Move CI to Azure Pipelines @@ -127,7 +128,7 @@ Special thanks to @YaronWittenstein @penberg for their contributions. - [#493](https://github.com/wasmerio/wasmer/pull/493) `wasmer_module_instantiate` has better error messages in the runtime C API - [#474](https://github.com/wasmerio/wasmer/pull/474) Set the install name of the dylib to `@rpath` - [#490](https://github.com/wasmerio/wasmer/pull/490) Add MiddlewareChain and StreamingCompiler to runtime -- [#487](https://github.com/wasmerio/wasmer/pull/487) Fix stack offset check in singlepass backend +- [#487](https://github.com/wasmerio/wasmer/pull/487) Fix stack offset check in singlepass backend - [#450](https://github.com/wasmerio/wasmer/pull/450) Added Metering - [#481](https://github.com/wasmerio/wasmer/pull/481) Added context trampoline into runtime - [#484](https://github.com/wasmerio/wasmer/pull/484) Fix bugs in emscripten socket syscalls diff --git a/README.md b/README.md index bfd45786bca..e69fe2d1cdb 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ ## Introduction -[Wasmer](https://wasmer.io/) is a standalone WebAssembly runtime, for running WebAssembly [outside of the Browser](https://webassembly.org/docs/non-web/), supporting [WASI](https://github.com/WebAssembly/WASI) and [Emscripten](https://emscripten.org/). +[Wasmer](https://wasmer.io/) is a standalone WebAssembly runtime for running WebAssembly [outside of the browser](https://webassembly.org/docs/non-web/), supporting [WASI](https://github.com/WebAssembly/WASI) and [Emscripten](https://emscripten.org/). Install the Wasmer CLI with: @@ -46,7 +46,7 @@ Wasmer runtime can be used as a library embedded in different languages, so you | ![Postgres logo](./docs/assets/languages/postgres.svg) | [**Postgres**](https://github.com/wasmerio/postgres-ext-wasm) | Wasmer | actively developed | ![last release](https://img.shields.io/github/v/release/wasmerio/postgres-ext-wasm?style=flat-square) | ![number of Github stars](https://img.shields.io/github/stars/wasmerio/postgres-ext-wasm?style=flat-square) | | ![C# logo](./docs/assets/languages/csharp.svg) | [**C#/.Net**](https://github.com/migueldeicaza/WasmerSharp) | [Miguel de Icaza](https://github.com/migueldeicaza) | actively developed | ![last release](https://img.shields.io/nuget/v/WasmerSharp?style=flat-square) | ![number of Github stars](https://img.shields.io/github/stars/migueldeicaza/WasmerSharp?style=flat-square) | | ![R logo](./docs/assets/languages/r.svg) | [**R**](https://github.com/dirkschumacher/wasmr) | [Dirk Schumacher](https://github.com/dirkschumacher) | actively developed | | ![number of Github stars](https://img.shields.io/github/stars/dirkschumacher/wasmr?style=flat-square) | -| ![Swift logo](./docs/assets/languages/swift.svg) | [**Swift**](https://github.com/markmals/swift-ext-wasm) | [Mark Malström](https://github.com/markmals/) | passively maintened | | ![number of Github stars](https://img.shields.io/github/stars/markmals/swift-ext-wasm?style=flat-square) | +| ![Swift logo](./docs/assets/languages/swift.svg) | [**Swift**](https://github.com/markmals/swift-ext-wasm) | [Mark Malström](https://github.com/markmals/) | passively maintained | | ![number of Github stars](https://img.shields.io/github/stars/markmals/swift-ext-wasm?style=flat-square) | | ❓ | [your language is missing?](https://github.com/wasmerio/wasmer/issues/new?assignees=&labels=%F0%9F%8E%89+enhancement&template=---feature-request.md&title=) | | | | ### Usage @@ -63,12 +63,12 @@ wasmer run examples/lua.wasm *You can find more `wasm/wat` examples in the [examples](./examples) directory.* -#### With WAPM +#### With wapm Installing Wasmer through `wasmer.io` includes [`wapm`](https://github.com/wasmerio/wapm-cli), the [WebAssembly Package Manager](https://wapm.io/). -Wapm allows you to easily download, run, and distribute WebAssembly binaries. +wapm allows you to easily download, run, and distribute WebAssembly binaries. ```sh # Install cowsay globally @@ -87,7 +87,7 @@ Wasmer is structured into different directories: - [`src`](./src): code related to the Wasmer executable itself - [`lib`](./lib): modularized libraries that Wasmer uses under the hood -- [`examples`](./examples): some useful examples to getting started with Wasmer +- [`examples`](./examples): some useful examples for getting started with Wasmer ## Dependencies @@ -118,7 +118,7 @@ If you have [Homebrew](https://brew.sh/) installed: brew install cmake ``` -Or, in case you have [MacPorts](https://www.macports.org/install.php): +Or, if you have [MacPorts](https://www.macports.org/install.php): ```sh sudo port install cmake @@ -136,6 +136,7 @@ sudo port install cmake ```sh sudo apt install cmake pkg-config libssl-dev ``` +

@@ -148,6 +149,7 @@ sudo apt install cmake pkg-config libssl-dev ```sh pkg install cmake ``` +

@@ -157,7 +159,7 @@ pkg install cmake #### Windows (MSVC) -Windows support is _experimental_. WASI is fully supported, but Emscripten support is on the works (this means +Windows support is _experimental_. WASI is fully supported, but Emscripten support is in the works (this means nginx and Lua do not work on Windows - you can track the progress on [this issue](https://github.com/wasmerio/wasmer/issues/176)). 1. Install [Visual Studio](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=15) @@ -173,10 +175,11 @@ nginx and Lua do not work on Windows - you can track the progress on [this issue 5. Install [CMake](https://cmake.org/download/). Ensure CMake is in your PATH. 6. Install [LLVM 8.0](https://prereleases.llvm.org/win-snapshots/LLVM-8.0.0-r351033-win64.exe) -

- +

+ ## Building + [![Rustc Version 1.37+](https://img.shields.io/badge/rustc-1.37+-red.svg?style=flat-square)](https://blog.rust-lang.org/2019/08/15/Rust-1.37.0.html) Wasmer is built with [Cargo](https://crates.io/), the Rust package manager. @@ -184,13 +187,15 @@ Wasmer is built with [Cargo](https://crates.io/), the Rust package manager. The Singlepass backend requires nightly, so if you want to use it, Set Rust Nightly: + ``` rustup default nightly ``` -Otherwise an up to date (see badge above) verison of stable Rust will work. +Otherwise an up to date (see badge above) version of stable Rust will work. And install Wasmer + ```sh # checkout code git clone https://github.com/wasmerio/wasmer.git @@ -236,7 +241,6 @@ Each integration can be tested separately: * Middleware: `make middleware` * C API: `make capi` - ## Benchmarking Benchmarks can be run with: @@ -258,7 +262,7 @@ Below are some of the goals of this project (in order of priority): - [x] It should be fast _(partially achieved)_ - [x] Support WASI - released in [0.3.0](https://github.com/wasmerio/wasmer/releases/tag/0.3.0) - [x] Support Emscripten calls _(in the works)_ -- [ ] Support Go js ABI calls +- [ ] Support Go JS ABI calls ## Architecture From 9be72e680822faba4d13f85ae09fd86084e20c8a Mon Sep 17 00:00:00 2001 From: Jordan Danford Date: Mon, 30 Sep 2019 22:50:04 -0700 Subject: [PATCH 2/2] Fix some other files too --- .github/ISSUE_TEMPLATE/---bug-report.md | 6 +++--- CONTRIBUTING.md | 20 ++++++++++---------- Makefile | 2 +- docs/feature_matrix.md | 1 - install.sh | 21 ++++++++++----------- integration_tests/cowsay/README.md | 3 +-- lib/clif-backend/README.md | 2 +- lib/llvm-backend/README.md | 2 +- lib/singlepass-backend/README.md | 2 +- 9 files changed, 28 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index ab619bfe402..470f5ea9b73 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -15,9 +15,9 @@ assignees: '' A clear and concise description of what the bug is. Copy and paste the result of executing the following in your shell, so we can know the version of wasmer, Rust (if available) and architecture of your environment. ---> +--> -```bash +```sh echo "`wasmer -V` | `rustc -V` | `uname -m`" ``` @@ -33,7 +33,7 @@ For example, 4. See error If applicable, add a link to a test case (as a zip file or link to a repository we can clone). ---> +--> ### Expected behavior diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c2f0d31e63..1685f472207 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,12 +3,15 @@ Thank you for your interest in contributing to Wasmer. This document outlines some recommendations on how to contribute. ## Issues & Feature Requests + Please use the issue template and provide a failing example if possible to help us recreate the issue. ## Pull Requests -For large changes, please try reaching the Wasmer using Github Issues or Spectrum Chat to ensure we can accept the change once it is ready. + +For large changes, please try reaching communicating with the Wasmer maintainers via GitHub Issues or Spectrum Chat to ensure we can accept the change once it is ready. We recommend trying the following commands before sending a pull request to ensure code quality: + - `cargo fmt --all` Ensures all code is correctly formatted. - Run `cargo test` in the crates that you are modifying. - Run `cargo build --all` (nightly) or `cargo build --all --exclude wasmer-singlepass-backend` @@ -17,17 +20,14 @@ A comprehensive CI test suite will be run by a Wasmer team member after the PR h ### Common Build Issues -**LLVM Dependency** +#### LLVM Dependency -The LLVM backend requires LLVM to be installed to compile. +`Didn't find usable system-wide LLVM` -So, you may run into the following error: -``` -Didn't find usable system-wide LLVM. -No suitable version of LLVM was found system-wide or pointed -``` +Building Wasmer with the LLVM backend requires LLVM to be installed -**Singlepass Nightly Only** +#### Singlepass Nightly Only -The singlepass crate depends on nightly so you may need to add the `+nightly` cargo flag to compile this crate. `error[E0554]: #![feature] may not be used on the stable release channel` + +Building Wasmer with the singlepass backend requires the nightly version of Rust diff --git a/Makefile b/Makefile index 89210b9b046..58b85dbb1a5 100644 --- a/Makefile +++ b/Makefile @@ -161,7 +161,7 @@ release: # Only one backend (cranelift) release-clif: - # If you are in OS-X, you will need mingw-w64 for cross compiling to windows + # If you are on macOS, you will need mingw-w64 for cross compiling to Windows # brew install mingw-w64 cargo build --release diff --git a/docs/feature_matrix.md b/docs/feature_matrix.md index a40bd7f169f..cdb6ff8ade9 100644 --- a/docs/feature_matrix.md +++ b/docs/feature_matrix.md @@ -12,7 +12,6 @@ | SIMD | ⬜ | ⬜ | ✅ | | WASI | ✅ | ✅ | ✅ | - ## Language integration TODO: define a set of features that are relevant and mark them here diff --git a/install.sh b/install.sh index b937505d6fc..a4fc2b841e6 100755 --- a/install.sh +++ b/install.sh @@ -1,8 +1,8 @@ #!/bin/sh # This install script is intended to download and install the latest available -# release of the wasmer. -# Installer script inspired from: +# release of Wasmer. +# Installer script inspired by: # 1) https://raw.githubusercontent.com/golang/dep/master/install.sh # 2) https://sh.rustup.rs # 3) https://yarnpkg.com/install.sh @@ -22,7 +22,6 @@ set -e - reset="\033[0m" red="\033[31m" green="\033[32m" @@ -257,10 +256,10 @@ wasmer_install() { printf "${reset}Installing Wasmer and WAPM!$reset\n" if [ "$WASMER_INSTALL_LOG" = "$WASMER_VERBOSE" ]; then printf " -${magenta1} ww -${magenta1} wwwww -${magenta1} ww wwwwww w -${magenta1} wwwww wwwwwwwww +${magenta1} ww +${magenta1} wwwww +${magenta1} ww wwwwww w +${magenta1} wwwww wwwwwwwww ${magenta1}ww wwwwww w wwwwwww ${magenta1}wwwww wwwwwwwwww wwwww ${magenta1}wwwwww w wwwwwww wwwww @@ -269,10 +268,10 @@ ${magenta1}wwwwwwwwwwwwwww wwwww wwwww ${magenta1}wwwwwwwwwwwwwww wwwww wwwww ${magenta1}wwwwwwwwwwwwwww wwwww wwwww ${magenta1}wwwwwwwwwwwwwww wwwww wwww -${magenta1}wwwwwwwwwwwwwww wwwww -${magenta1} wwwwwwwwwwww wwww -${magenta1} wwwwwwww -${magenta1} wwww +${magenta1}wwwwwwwwwwwwwww wwwww +${magenta1} wwwwwwwwwwww wwww +${magenta1} wwwwwwww +${magenta1} wwww ${reset} " fi diff --git a/integration_tests/cowsay/README.md b/integration_tests/cowsay/README.md index f44e6e6804a..660e457e7bc 100644 --- a/integration_tests/cowsay/README.md +++ b/integration_tests/cowsay/README.md @@ -1,9 +1,8 @@ # `cowsay` integration test - This starts Wasmer with the Cowsay WASI Wasm file. The test makes assertions on the output of Wasmer. Run test with: -```bash +```sh ./integration_tests/cowsay/test.sh ``` diff --git a/lib/clif-backend/README.md b/lib/clif-backend/README.md index 7cb3023bf3d..9c82c761d43 100644 --- a/lib/clif-backend/README.md +++ b/lib/clif-backend/README.md @@ -36,7 +36,7 @@ This crate represents the Cranelift backend integration for Wasmer. If you are using the `wasmer` CLI, you can specify the backend with: -```bash +```sh wasmer run program.wasm --backend=cranelift ``` diff --git a/lib/llvm-backend/README.md b/lib/llvm-backend/README.md index e82396c6170..584b375858c 100644 --- a/lib/llvm-backend/README.md +++ b/lib/llvm-backend/README.md @@ -36,7 +36,7 @@ This crate represents the LLVM backend integration for Wasmer. If you are using the `wasmer` CLI, you can specify the backend with: -```bash +```sh wasmer run program.wasm --backend=llvm ``` diff --git a/lib/singlepass-backend/README.md b/lib/singlepass-backend/README.md index 4460dcd2707..cf9ee566c9c 100644 --- a/lib/singlepass-backend/README.md +++ b/lib/singlepass-backend/README.md @@ -37,7 +37,7 @@ This crate represents the Singlepass backend integration for Wasmer. If you are using the `wasmer` CLI, you can specify the backend with: -```bash +```sh wasmer run program.wasm --backend=singlepass ```