wasm4/assets/templates/readme-template.md

Build retro games using WebAssembly for a fantasy console.

# {{name}}

A game written in {{lang.name}} for the [WASM-4](https://wasm4.org) fantasy console.

## Building

{{#lang.setup}}
First setup the project by running:

```shell
{{{lang.setup}}}
```

{{/lang.setup}}
Build the cart by running:

```shell
{{{lang.build}}}
```

Then run it with:

```shell
w4 run {{{lang.cart}}}
```

For more info about setting up WASM-4, see the [quickstart guide](https://wasm4.org/docs/getting-started/setup?code-lang={{code-lang}}#quickstart).

## Links

- [Documentation](https://wasm4.org/docs): Learn more about WASM-4.
- [Snake Tutorial](https://wasm4.org/docs/tutorials/snake/goal): Learn how to build a complete game
  with a step-by-step tutorial.
- [GitHub](https://github.com/aduros/wasm4): Submit an issue or PR. Contributions are welcome!