doc: add README and gitignore

This commit is contained in:
Orangerot 2025-05-10 17:45:52 +02:00
parent 62944b57a2
commit c37f91d2d2
2 changed files with 38 additions and 0 deletions

4
.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
*.wasm
*.out
wai

34
README.md Normal file
View file

@ -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 <https://www.gnu.org/licenses/>.
```