Skip to content

Miscellaneous doc updates #1383

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

Merged
merged 2 commits into from
Mar 23, 2020
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
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Hello, world!

* **Lightweight**. Wasmtime is a standalone runtime for WebAssembly that scales
with your needs. It fits on tiny chips as well as makes use of huge servers.
Wasmtime can be embedded into almost any application too.
Wasmtime can be [embedded] into almost any application too.

* **Fast**. Wasmtime is built on the optimizing [Cranelift] code generator to
quickly generate high-quality machine code at runtime.
Expand All @@ -83,6 +83,7 @@ Hello, world!
standards process all along the way too.

[Cranelift]: https://github.com/bytecodealliance/wasmtime/blob/master/cranelift/README.md
[embedded]: https://bytecodealliance.github.io/wasmtime/embed.html

## Documentation

Expand Down
6 changes: 4 additions & 2 deletions cranelift/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,10 @@ Contributing
------------

If you're interested in contributing to Cranelift: thank you! We have a
[contributing guide](CONTRIBUTING.md) which will help you getting involved in
the Cranelift project.
[contributing guide] which will help you getting involved in the Cranelift
project.

[contributing guide](https://bytecodealliance.github.io/wasmtime/contributing.html)

Planned uses
------------
Expand Down
4 changes: 4 additions & 0 deletions crates/jit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,9 @@ This is the `wasmtime-jit` crate, which contains JIT-based execution
for wasm, using the wasm ABI defined by [`wasmtime-environ`] and the
runtime support provided by [`wasmtime-runtime`].

Most users will want to use the main [`wasmtime`] crate instead of using this
crate directly.

[`wasmtime-environ`]: https://crates.io/crates/wasmtime-environ
[`wasmtime-runtime`]: https://crates.io/crates/wasmtime-runtime
[`wasmtime`]: https://crates.io/crates/wasmtime
4 changes: 4 additions & 0 deletions crates/runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ support, supporting the wasm ABI used by [`wasmtime-environ`],
This crate does not make a host vs. target distinction; it is meant to be
compiled for the target.

Most users will want to use the main [`wasmtime`] crate instead of using this
crate directly.

[`wasmtime-environ`]: https://crates.io/crates/wasmtime-environ
[`wasmtime-jit`]: https://crates.io/crates/wasmtime-jit
[`wasmtime-obj`]: https://crates.io/crates/wasmtime-obj
[`wasmtime`]: https://crates.io/crates/wasmtime
2 changes: 1 addition & 1 deletion docs/embed-rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ crate][wasmtime] has to offer and the [book examples for
Rust](./examples-rust-embed.md) for more information.

[apidoc]: https://bytecodealliance.github.io/wasmtime/api/wasmtime/
[wasmtime]: https://crates.io/crates/wasmtime
[crate]: https://crates.io/crates/wasmtime

## Creating the WebAssembly to execute

Expand Down
9 changes: 8 additions & 1 deletion docs/embed.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Embedding Wasmtime

... more coming soon
Wasmtime can be used as a library to embed WebAssembly execution support
within applications. It has a Rust API, and also supports the official
[WebAssembly C API].

* [Rust](embed-rust.md)
* [C](embed-c.md)

[WebAssembly C API]: https://github.com/WebAssembly/wasm-c-api
6 changes: 5 additions & 1 deletion docs/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Tutorial

... more coming soon
This tutorial walks through creating a simple Hello World WebAssembly program
and then running it.

* [Creating `hello-world.wasm`](tutorial-create-hello-world.md)
* [Running `hello-world.wasm`](tutorial-run-hello-world.md)