diff --git a/README.md b/README.md index df24916..38a0f37 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ -This is a WebAssembly to Lua translation tool. The generated code is designed to run without any dependencies past the bundled runtime. +# Wasynth -You can run the tool via `program help` to list command line instructions. +This is a WebAssembly translation tool and library for arbitrary languages. It contains several modules for different purposes as outlined below. + +* `wasm-ast` handles creating abstract syntax trees which can be used to inspect and act on WebAssembly code. +* `codegen/*` handles individual code generation libraries that consume the syntax trees. +* `dev-test/tests/*` handles testing the code generation against the standard test suite. +* `dev-test/fuzz_targets/*` handles testing syntax tree building through fuzzing of pseudo-random data. + +## Code Generation + +The code generation libraries also offer a simple binary utility for translating to source. These can be built or installed by using the `--path codegen/language --bin wasm2language` Cargo flags. | | | | |----------|-----------------|-----------------------| | LuaJIT | :green_circle: | Minimum version 2.1.0 | | Luau | :yellow_circle: | | -| Lua 5.4 | :red_circle: | |