summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOrangerot <purple@orangerot.dev>2025-05-10 17:45:52 +0200
committerOrangerot <purple@orangerot.dev>2025-05-10 17:48:14 +0200
commitc37f91d2d2a5ebd5b89dda88ecd97f8b7f5cf85e (patch)
treeab86d74a7c9b2caa68f20c21664ed32fa565e1b5
parent62944b57a2a83a9c0f21aa6bffaf019fbe53ea4d (diff)
doc: add README and gitignore
-rw-r--r--.gitignore4
-rw-r--r--README.md34
2 files changed, 38 insertions, 0 deletions
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 <https://www.gnu.org/licenses/>.
+```