diff options
Diffstat (limited to 'examples/doom/README.md')
| -rw-r--r-- | examples/doom/README.md | 19 |
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 +``` |