Fix some other files too

This commit is contained in:
Jordan Danford 2019-09-30 22:50:04 -07:00
parent 5a92e6b450
commit 9be72e6808
9 changed files with 28 additions and 31 deletions

View File

@ -17,7 +17,7 @@ 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`"
```

View File

@ -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

View File

@ -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

View File

@ -12,7 +12,6 @@
| SIMD | ⬜ | ⬜ | ✅ |
| WASI | ✅ | ✅ | ✅ |
## Language integration
TODO: define a set of features that are relevant and mark them here

View File

@ -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"

View File

@ -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
```

View File

@ -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
```

View File

@ -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
```

View File

@ -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
```