summaryrefslogtreecommitdiff
path: root/examples/doom/README.md
diff options
context:
space:
mode:
authorHenry <mail@henrygressmann.de>2026-05-02 15:40:47 +0200
committerHenry <mail@henrygressmann.de>2026-05-02 15:45:44 +0200
commit5ed8982ad2cb4b348046aa11c527ce6a51f02e0e (patch)
treec5427ac3ffdeedfa37b698eeb4f2dac09859b4a6 /examples/doom/README.md
parent361b715de9ea6a859aaafe84d4bcd3d46ed70797 (diff)
feat: add doom example, fix import argument order
Signed-off-by: Henry <mail@henrygressmann.de>
Diffstat (limited to 'examples/doom/README.md')
-rw-r--r--examples/doom/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/doom/README.md b/examples/doom/README.md
new file mode 100644
index 0000000..f3bc60e
--- /dev/null
+++ b/examples/doom/README.md
@@ -0,0 +1,19 @@
+# Doom Example
+
+This example builds a WebAssembly guest from [`PureDOOM`](https://github.com/Daivuk/PureDOOM) and runs it inside `tinywasm`. The host uses `winit` and `softbuffer` to present the framebuffer.
+
+## Prerequisites
+
+- `clang`
+- `git`
+- a Doom WAD that you provide yourself
+
+## Running the example
+
+```sh
+# download & build `PureDOOM`
+./examples/doom/build.sh
+
+# start doom with the WAD you want to use
+cargo run -p tinywasm-doom --release -- /path/to/DOOM1.WAD
+```