fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2025-03-17 16:50:48 +00:00
Code Issues Projects Releases Wiki Activity
wasmer/lib
History
bors[bot] 4099cc1984
Merge #1142 
1142: doc(runtime-c-api) Setup Doxygen r=syrusakbary a=Hywan

With @MarkMcCaskey, we discussed generating the documentation of `wasmer-runtime-c-api` with [Doxygen](http://www.doxygen.nl/).

This patch does the following:

1. Set up a `doxyfile`, which is the configuration file for Doxygen.
2. Set up a `doc/header.html` and `doc/footer.html` files, because Doxygen HTML output is… well, not a master piece 😉.
3. Set up a `doc/css/wasmer.css` stylesheet. I tried to mimic Wasmer color scheme. Usually, I'm not a bad designer, but Doxygen HTML output is so “alembic-ed” that it makes customizing the CSS a real challenge for the very short period of time I've.

Anyway, I believe it's an acceptable first step.

To generate the documentation:

```sh
$ doxygen doxyfile
```

And then open `doc/html/index.html`.

It looks like this:

![Screen Shot 2020-01-13 at 15 20 09](https://user-images.githubusercontent.com/946104/72263046-692ea100-3618-11ea-9feb-6dfd3244d375.png)
![Screen Shot 2020-01-13 at 15 20 25](https://user-images.githubusercontent.com/946104/72263072-70ee4580-3618-11ea-941d-fa652bd7f14e.png)
![Screen Shot 2020-01-13 at 15 20 35](https://user-images.githubusercontent.com/946104/72263082-7481cc80-3618-11ea-81e7-f4da7b71d665.png)
![Screen Shot 2020-01-13 at 15 20 57](https://user-images.githubusercontent.com/946104/72263098-78155380-3618-11ea-9cfc-16b7695c9e89.png)

The next step is to publish the documentation on Github Pages, thoughts @syrusakbary?

Co-authored-by: Ivan Enderlin <ivan.enderlin@hoa-project.net>
2020-01-14 08:08:06 +00:00
..
clif-backend
Remove Backend dependency
2020-01-07 16:12:39 +01:00
dev-utils
Prepare for 0.12.0 release
2019-12-18 17:24:29 -05:00
emscripten
Revert emscripten changes
2019-12-20 19:09:07 -08:00
emscripten-tests
Prepare for 0.12.0 release
2019-12-18 17:24:29 -05:00
kernel-loader
Add MIT license to crates that were missing it
2019-12-22 12:28:33 +01:00
kernel-net
Add MIT license to crates that were missing it
2019-12-22 12:28:33 +01:00
llvm-backend
Make all tests pass
2020-01-07 16:12:39 +01:00
llvm-backend-tests
Add MIT license to crates that were missing it
2019-12-22 12:28:33 +01:00
middleware-common
Prepare for 0.12.0 release
2019-12-18 17:24:29 -05:00
middleware-common-tests
Fixed lint
2020-01-13 12:04:39 +01:00
runtime
Merge branch 'master' into backend-refactor
2020-01-10 13:41:49 +01:00
runtime-c-api
Merge #1142
2020-01-14 08:08:06 +00:00
runtime-core
Merge branch 'master' into backend-refactor
2020-01-10 13:41:49 +01:00
runtime-core-tests
Prepare for 0.12.0 release
2019-12-18 17:24:29 -05:00
singlepass-backend
Remove Backend dependency
2020-01-07 16:12:39 +01:00
spectests
Add tests for non-trapping float to int conversions.
2019-12-20 16:20:58 -08:00
wasi
Add misc doc link fixes and update old comment
2019-12-19 16:22:51 -05:00
wasi-experimental-io-devices
Update io device file name
2020-01-13 17:56:46 -08:00
wasi-tests
Prepare for 0.12.0 release
2019-12-18 17:24:29 -05:00
win-exception-handler
Prepare for 0.12.0 release
2019-12-18 17:24:29 -05:00
.gitignore
…
README.md
Renamed dynasm backend to singlepass
2019-04-11 12:44:03 -07:00

README.md

Wasmer Libraries

Wasmer is modularized into different libraries, separated into three main sections:

Runtime

The core of Wasmer is the runtime, which provides the necessary abstractions to create a good user experience when embedding.

The runtime is divided into two main libraries:

  • runtime-core: The main implementation of the runtime.
  • runtime: Easy-to-use API on top of runtime-core.

Integrations

The integration builds on the Wasmer runtime and allow us to run WebAssembly files compiled for different environments.

Wasmer intends to support different integrations:

  • WASI: run WebAssembly files with the WASI ABI.
  • Emscripten: run Emscripten-generated WebAssembly files, such as Lua or nginx.
  • Go ABI: we will work on this soon! Want to give us a hand? ✋
  • Blazor: research period, see tracking issue

Backends

The Wasmer runtime is designed to support multiple compiler backends, allowing the user to tune the codegen properties (compile speed, performance, etc) to best fit their use case.

Currently, we support multiple backends for compiling WebAssembly to machine code:

  • singlepass-backend: Single pass backend - super fast compilation, slower runtime speed
  • clif-backend: Cranelift backend - slower compilation, normal runtime speed
  • llvm-backend: LLVM backend - slow compilation, native runtime speed