code002lover/Wasynth
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add new README

Browse Source
This commit is contained in:
Rerumu 2022-06-23 20:47:23 -04:00
parent d20237e1fe
commit 3baeb1df59
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -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 | | LuaJIT | :green_circle: | Minimum version 2.1.0 |
| Luau | :yellow_circle: | | | Luau | :yellow_circle: | |
| Lua 5.4 | :red_circle: | |