From 1b98efd97912230b52de47d26e7e42dc399e503e Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Mon, 3 Dec 2018 16:47:59 -0800 Subject: [PATCH] Add a README.md for lib/obj. --- lib/obj/Cargo.toml | 2 ++ lib/obj/README.md | 6 ++++++ 2 files changed, 8 insertions(+) create mode 100644 lib/obj/README.md diff --git a/lib/obj/Cargo.toml b/lib/obj/Cargo.toml index 53f8fec53d..b6fc681398 100644 --- a/lib/obj/Cargo.toml +++ b/lib/obj/Cargo.toml @@ -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" diff --git a/lib/obj/README.md b/lib/obj/README.md new file mode 100644 index 0000000000..3b3e0f1fee --- /dev/null +++ b/lib/obj/README.md @@ -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 +