Miscellaneous doc updates (#1383)
* Add additional links to embedding and tutorial documentation. * Fix a broken link to CONTRIBUTING.md. Fixes #1280.
This commit is contained in:
@@ -64,7 +64,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.
|
||||
@@ -84,6 +84,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
|
||||
|
||||
|
||||
@@ -60,8 +60,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
|
||||
------------
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user