From c37f91d2d2a5ebd5b89dda88ecd97f8b7f5cf85e Mon Sep 17 00:00:00 2001 From: Orangerot Date: Sat, 10 May 2025 17:45:52 +0200 Subject: [PATCH] doc: add README and gitignore --- .gitignore | 4 ++++ README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..09135a0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*.wasm +*.out +wai + diff --git a/README.md b/README.md new file mode 100644 index 0000000..919eda0 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# WAI +> WebAssembly Interpreter + +## Usage + +Dependencies: wat2wasm from [wabt](https://github.com/WebAssembly/wabt/tree/main) + +```sh +make +make tests +./wai tests/factorial.wasw +``` + +## Resources + +- WebAssembly Specification [[Web](https://webassembly.github.io/spec/core/)] [[PDF](https://webassembly.github.io/spec/core/_download/WebAssembly.pdf)] +- [wat2wasm online](https://webassembly.github.io/wabt/demo/wat2wasm/index.html) + +## License + +``` +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +```