Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README with project status and goals. #35

Merged
merged 6 commits into from
Dec 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at either sunfish@mozilla.com or tyler@fastly.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contributing to Wasmtime

Wasmtime follows the same development style as Cranelift, so checkout
[Cranelift's CONTRIBUTING.md]. Of course, for Wasmtime-specific issues, please
use the [Wasmtime issue tracker].

[Cranelift's CONTRIBUTING.md]: https://github.com/CraneStation/cranelift/blob/master/CONTRIBUTING.md
[Wasmtime issue tracker]: https://github.com/CraneStation/wasmtime/issues/new
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,28 @@
# wasmtime
Standalone JIT-style runtime support for WebAsssembly code in Cranelift
# Wasmtime: a WebAssembly Runtime.

A standalone wasm-only runtime for [WebAssembly], using [Cranelift].

[![Travis Status](https://travis-ci.org/CraneStation/wasmtime.svg?branch=master)](https://travis-ci.org/CraneStation/wasmtime)
[![Appveyor Status](https://ci.appveyor.com/api/projects/status/vxvpt2plriy5s0mc?svg=true)](https://ci.appveyor.com/project/CraneStation/cranelift)
[![Gitter chat](https://badges.gitter.im/CraneStation/CraneStation.svg)](https://gitter.im/CraneStation/Lobby)
![Minimum rustc 1.30](https://img.shields.io/badge/rustc-1.30+-red.svg)
![Minimum rustc 1.30](https://img.shields.io/badge/rustc-1.30+-green.svg)

*This is a work in progress that is not currently functional, but under active development.*

Goals include:
- Be a general-purpose engine for running WebAssembly code [outside of browsers],
usable both standalone or as a library embedded in a larger application.
- Support a variety of host APIs with fast calling sequences.
- Prototype syscall APIs that can be proposed for use in the WebAssembly
[Reference Sysroot](https://github.com/WebAssembly/reference-sysroot).
- Facilitate testing, experimentation, and development around the [Cranelift] and
[Lightbeam] JITs.
- Develop a the native ABI used for compiling WebAssembly suitable for use in
both JIT and AOT to native object files.

[WebAssembly]: https://webassembly.org/
[outside of browsers]: https://github.com/WebAssembly/design/blob/master/NonWeb.md
[Cranelift]: https://github.com/CraneStation/cranelift
[Lightbeam]: https://github.com/CraneStation/lightbeam

*This is a work in progress that is not currently functional.*
It's Wasmtime.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's Wasmtime.

2 changes: 2 additions & 0 deletions lib/obj/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
name = "wasmtime-obj"
version = "0.0.0"
authors = ["The Cranelift Project Developers"]
description = "Native object file output for WebAsssembly code in Wasmtime"
publish = false
repository = "https://github.com/CraneStation/wasmtime"
categories = ["wasm"]
license = "Apache-2.0 WITH LLVM-exception"
readme = "README.md"

[dependencies]
cranelift-codegen = "0.25.0"
Expand Down
6 changes: 6 additions & 0 deletions lib/obj/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
This is the `wasmtime-obj` crate, which contains an experimental prototype
for writing out native object files, using the wasm ABI defined by
[`wasmtime-environ`].

[`wasmtime-environ`]: https://crates.io/crates/wasmtime-environ