From 068f86f6455ab497b0e23ff6dfaf3fcc8e78f043 Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Tue, 30 Oct 2018 10:06:38 -0700 Subject: [PATCH] Add a basic README.md. --- Cargo.toml | 1 + README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 066cf29ec5..34ecb9f4c2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,7 @@ name = "wasm-singlepass-experiment" version = "0.0.0" authors = ["Dan Gohman "] license = "Apache-2.0 WITH LLVM-exception" +readme = "README.md" publish = false [dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000000..1a38d3548a --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Wasm Singlepass Experiment + +This is an early-stage experimental project to build a single-pass +wasm-function-to-machine-code translator. + +It's currently built with [dynasm](https://crates.io/crates/dynasm) and +targets x86-64, however the function\_body.rs/backend.rs split is likely +to evolve towards a configuration point allowing other targets or even +other assemblers to be supported. + +It's a very early stage project, and a good one for learning how +WebAssembly works at a low level, for learning assembly programming, or +both! And we're happy to mentor. So welcome, and check out the +[issue tracker] to see what's happening and how to get involved! + +[issue tracker]: https://github.com/sunfishcode/wasm-singlepass-experiment/issues